1. Packages
  2. Routeros Provider
  3. API Docs
  4. IpSmb
routeros 1.83.0 published on Wednesday, Apr 16, 2025 by terraform-routeros

routeros.IpSmb

Explore with Pulumi AI

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as routeros from "@pulumi/routeros";

const test = new routeros.IpSmb("test", {
    comment: "MikrotikSMB",
    domain: "MSHOME",
    enabled: "auto",
    interfaces: ["all"],
});
Copy
import pulumi
import pulumi_routeros as routeros

test = routeros.IpSmb("test",
    comment="MikrotikSMB",
    domain="MSHOME",
    enabled="auto",
    interfaces=["all"])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/routeros/routeros"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := routeros.NewIpSmb(ctx, "test", &routeros.IpSmbArgs{
			Comment: pulumi.String("MikrotikSMB"),
			Domain:  pulumi.String("MSHOME"),
			Enabled: pulumi.String("auto"),
			Interfaces: pulumi.StringArray{
				pulumi.String("all"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Routeros = Pulumi.Routeros;

return await Deployment.RunAsync(() => 
{
    var test = new Routeros.IpSmb("test", new()
    {
        Comment = "MikrotikSMB",
        Domain = "MSHOME",
        Enabled = "auto",
        Interfaces = new[]
        {
            "all",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.routeros.IpSmb;
import com.pulumi.routeros.IpSmbArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new IpSmb("test", IpSmbArgs.builder()
            .comment("MikrotikSMB")
            .domain("MSHOME")
            .enabled("auto")
            .interfaces("all")
            .build());

    }
}
Copy
resources:
  test:
    type: routeros:IpSmb
    properties:
      comment: MikrotikSMB
      domain: MSHOME
      enabled: auto
      interfaces:
        - all
Copy

Create IpSmb Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new IpSmb(name: string, args?: IpSmbArgs, opts?: CustomResourceOptions);
@overload
def IpSmb(resource_name: str,
          args: Optional[IpSmbArgs] = None,
          opts: Optional[ResourceOptions] = None)

@overload
def IpSmb(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          ___id_: Optional[float] = None,
          ___path_: Optional[str] = None,
          comment: Optional[str] = None,
          domain: Optional[str] = None,
          enabled: Optional[str] = None,
          interfaces: Optional[Sequence[str]] = None,
          ip_smb_id: Optional[str] = None)
func NewIpSmb(ctx *Context, name string, args *IpSmbArgs, opts ...ResourceOption) (*IpSmb, error)
public IpSmb(string name, IpSmbArgs? args = null, CustomResourceOptions? opts = null)
public IpSmb(String name, IpSmbArgs args)
public IpSmb(String name, IpSmbArgs args, CustomResourceOptions options)
type: routeros:IpSmb
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args IpSmbArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args IpSmbArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args IpSmbArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args IpSmbArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IpSmbArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

IpSmb Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The IpSmb resource accepts the following input properties:

Comment string
Set comment for the server.
Domain string
Name of Windows Workgroup.
Enabled string
The default value is 'auto'. This means that the SMB server will automatically be enabled when the first non-disabled SMB share is configured under '/ip smb share'.
Interfaces List<string>
List of interfaces on which SMB service will be running.
IpSmbId string
The ID of this resource.
___id_ double
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
Comment string
Set comment for the server.
Domain string
Name of Windows Workgroup.
Enabled string
The default value is 'auto'. This means that the SMB server will automatically be enabled when the first non-disabled SMB share is configured under '/ip smb share'.
Interfaces []string
List of interfaces on which SMB service will be running.
IpSmbId string
The ID of this resource.
___id_ float64
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___id_ Double
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
comment String
Set comment for the server.
domain String
Name of Windows Workgroup.
enabled String
The default value is 'auto'. This means that the SMB server will automatically be enabled when the first non-disabled SMB share is configured under '/ip smb share'.
interfaces List<String>
List of interfaces on which SMB service will be running.
ipSmbId String
The ID of this resource.
___id_ number
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
comment string
Set comment for the server.
domain string
Name of Windows Workgroup.
enabled string
The default value is 'auto'. This means that the SMB server will automatically be enabled when the first non-disabled SMB share is configured under '/ip smb share'.
interfaces string[]
List of interfaces on which SMB service will be running.
ipSmbId string
The ID of this resource.
___id_ float
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ str
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
comment str
Set comment for the server.
domain str
Name of Windows Workgroup.
enabled str
The default value is 'auto'. This means that the SMB server will automatically be enabled when the first non-disabled SMB share is configured under '/ip smb share'.
interfaces Sequence[str]
List of interfaces on which SMB service will be running.
ip_smb_id str
The ID of this resource.
___id_ Number
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
comment String
Set comment for the server.
domain String
Name of Windows Workgroup.
enabled String
The default value is 'auto'. This means that the SMB server will automatically be enabled when the first non-disabled SMB share is configured under '/ip smb share'.
interfaces List<String>
List of interfaces on which SMB service will be running.
ipSmbId String
The ID of this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the IpSmb resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Status string
Id string
The provider-assigned unique ID for this managed resource.
Status string
id String
The provider-assigned unique ID for this managed resource.
status String
id string
The provider-assigned unique ID for this managed resource.
status string
id str
The provider-assigned unique ID for this managed resource.
status str
id String
The provider-assigned unique ID for this managed resource.
status String

Look up Existing IpSmb Resource

Get an existing IpSmb resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: IpSmbState, opts?: CustomResourceOptions): IpSmb
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ___id_: Optional[float] = None,
        ___path_: Optional[str] = None,
        comment: Optional[str] = None,
        domain: Optional[str] = None,
        enabled: Optional[str] = None,
        interfaces: Optional[Sequence[str]] = None,
        ip_smb_id: Optional[str] = None,
        status: Optional[str] = None) -> IpSmb
func GetIpSmb(ctx *Context, name string, id IDInput, state *IpSmbState, opts ...ResourceOption) (*IpSmb, error)
public static IpSmb Get(string name, Input<string> id, IpSmbState? state, CustomResourceOptions? opts = null)
public static IpSmb get(String name, Output<String> id, IpSmbState state, CustomResourceOptions options)
resources:  _:    type: routeros:IpSmb    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Comment string
Set comment for the server.
Domain string
Name of Windows Workgroup.
Enabled string
The default value is 'auto'. This means that the SMB server will automatically be enabled when the first non-disabled SMB share is configured under '/ip smb share'.
Interfaces List<string>
List of interfaces on which SMB service will be running.
IpSmbId string
The ID of this resource.
Status string
___id_ double
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
Comment string
Set comment for the server.
Domain string
Name of Windows Workgroup.
Enabled string
The default value is 'auto'. This means that the SMB server will automatically be enabled when the first non-disabled SMB share is configured under '/ip smb share'.
Interfaces []string
List of interfaces on which SMB service will be running.
IpSmbId string
The ID of this resource.
Status string
___id_ float64
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___id_ Double
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
comment String
Set comment for the server.
domain String
Name of Windows Workgroup.
enabled String
The default value is 'auto'. This means that the SMB server will automatically be enabled when the first non-disabled SMB share is configured under '/ip smb share'.
interfaces List<String>
List of interfaces on which SMB service will be running.
ipSmbId String
The ID of this resource.
status String
___id_ number
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
comment string
Set comment for the server.
domain string
Name of Windows Workgroup.
enabled string
The default value is 'auto'. This means that the SMB server will automatically be enabled when the first non-disabled SMB share is configured under '/ip smb share'.
interfaces string[]
List of interfaces on which SMB service will be running.
ipSmbId string
The ID of this resource.
status string
___id_ float
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ str
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
comment str
Set comment for the server.
domain str
Name of Windows Workgroup.
enabled str
The default value is 'auto'. This means that the SMB server will automatically be enabled when the first non-disabled SMB share is configured under '/ip smb share'.
interfaces Sequence[str]
List of interfaces on which SMB service will be running.
ip_smb_id str
The ID of this resource.
status str
___id_ Number
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
comment String
Set comment for the server.
domain String
Name of Windows Workgroup.
enabled String
The default value is 'auto'. This means that the SMB server will automatically be enabled when the first non-disabled SMB share is configured under '/ip smb share'.
interfaces List<String>
List of interfaces on which SMB service will be running.
ipSmbId String
The ID of this resource.
status String

Import

$ pulumi import routeros:index/ipSmb:IpSmb test .
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
routeros terraform-routeros/terraform-provider-routeros
License
Notes
This Pulumi package is based on the routeros Terraform Provider.