1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectCifsDomaincontroller
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev

fortimanager.ObjectCifsDomaincontroller

Explore with Pulumi AI

Define known domain controller servers.

Create ObjectCifsDomaincontroller Resource

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

Constructor syntax

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

@overload
def ObjectCifsDomaincontroller(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               adom: Optional[str] = None,
                               domain_name: Optional[str] = None,
                               ip: Optional[str] = None,
                               ip6: Optional[str] = None,
                               object_cifs_domaincontroller_id: Optional[str] = None,
                               passwords: Optional[Sequence[str]] = None,
                               port: Optional[float] = None,
                               scopetype: Optional[str] = None,
                               server_name: Optional[str] = None,
                               username: Optional[str] = None)
func NewObjectCifsDomaincontroller(ctx *Context, name string, args *ObjectCifsDomaincontrollerArgs, opts ...ResourceOption) (*ObjectCifsDomaincontroller, error)
public ObjectCifsDomaincontroller(string name, ObjectCifsDomaincontrollerArgs? args = null, CustomResourceOptions? opts = null)
public ObjectCifsDomaincontroller(String name, ObjectCifsDomaincontrollerArgs args)
public ObjectCifsDomaincontroller(String name, ObjectCifsDomaincontrollerArgs args, CustomResourceOptions options)
type: fortimanager:ObjectCifsDomaincontroller
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 ObjectCifsDomaincontrollerArgs
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 ObjectCifsDomaincontrollerArgs
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 ObjectCifsDomaincontrollerArgs
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 ObjectCifsDomaincontrollerArgs
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. ObjectCifsDomaincontrollerArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var objectCifsDomaincontrollerResource = new Fortimanager.ObjectCifsDomaincontroller("objectCifsDomaincontrollerResource", new()
{
    Adom = "string",
    DomainName = "string",
    Ip = "string",
    Ip6 = "string",
    ObjectCifsDomaincontrollerId = "string",
    Passwords = new[]
    {
        "string",
    },
    Port = 0,
    Scopetype = "string",
    ServerName = "string",
    Username = "string",
});
Copy
example, err := fortimanager.NewObjectCifsDomaincontroller(ctx, "objectCifsDomaincontrollerResource", &fortimanager.ObjectCifsDomaincontrollerArgs{
Adom: pulumi.String("string"),
DomainName: pulumi.String("string"),
Ip: pulumi.String("string"),
Ip6: pulumi.String("string"),
ObjectCifsDomaincontrollerId: pulumi.String("string"),
Passwords: pulumi.StringArray{
pulumi.String("string"),
},
Port: pulumi.Float64(0),
Scopetype: pulumi.String("string"),
ServerName: pulumi.String("string"),
Username: pulumi.String("string"),
})
Copy
var objectCifsDomaincontrollerResource = new ObjectCifsDomaincontroller("objectCifsDomaincontrollerResource", ObjectCifsDomaincontrollerArgs.builder()
    .adom("string")
    .domainName("string")
    .ip("string")
    .ip6("string")
    .objectCifsDomaincontrollerId("string")
    .passwords("string")
    .port(0)
    .scopetype("string")
    .serverName("string")
    .username("string")
    .build());
Copy
object_cifs_domaincontroller_resource = fortimanager.ObjectCifsDomaincontroller("objectCifsDomaincontrollerResource",
    adom="string",
    domain_name="string",
    ip="string",
    ip6="string",
    object_cifs_domaincontroller_id="string",
    passwords=["string"],
    port=0,
    scopetype="string",
    server_name="string",
    username="string")
Copy
const objectCifsDomaincontrollerResource = new fortimanager.ObjectCifsDomaincontroller("objectCifsDomaincontrollerResource", {
    adom: "string",
    domainName: "string",
    ip: "string",
    ip6: "string",
    objectCifsDomaincontrollerId: "string",
    passwords: ["string"],
    port: 0,
    scopetype: "string",
    serverName: "string",
    username: "string",
});
Copy
type: fortimanager:ObjectCifsDomaincontroller
properties:
    adom: string
    domainName: string
    ip: string
    ip6: string
    objectCifsDomaincontrollerId: string
    passwords:
        - string
    port: 0
    scopetype: string
    serverName: string
    username: string
Copy

ObjectCifsDomaincontroller 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 ObjectCifsDomaincontroller resource accepts the following input properties:

Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
DomainName string
Fully qualified domain name (FQDN). E.g. 'EXAMPLE.COM'.
Ip string
IPv4 server address.
Ip6 string
IPv6 server address.
ObjectCifsDomaincontrollerId string
an identifier for the resource with format {{server_name}}.
Passwords List<string>
Password for specified username.
Port double
Port number of service. Port number 0 indicates automatic discovery.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
ServerName string
Name of the server to connect to.
Username string
User name to sign in with. Must have proper permissions for service.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
DomainName string
Fully qualified domain name (FQDN). E.g. 'EXAMPLE.COM'.
Ip string
IPv4 server address.
Ip6 string
IPv6 server address.
ObjectCifsDomaincontrollerId string
an identifier for the resource with format {{server_name}}.
Passwords []string
Password for specified username.
Port float64
Port number of service. Port number 0 indicates automatic discovery.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
ServerName string
Name of the server to connect to.
Username string
User name to sign in with. Must have proper permissions for service.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
domainName String
Fully qualified domain name (FQDN). E.g. 'EXAMPLE.COM'.
ip String
IPv4 server address.
ip6 String
IPv6 server address.
objectCifsDomaincontrollerId String
an identifier for the resource with format {{server_name}}.
passwords List<String>
Password for specified username.
port Double
Port number of service. Port number 0 indicates automatic discovery.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
serverName String
Name of the server to connect to.
username String
User name to sign in with. Must have proper permissions for service.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
domainName string
Fully qualified domain name (FQDN). E.g. 'EXAMPLE.COM'.
ip string
IPv4 server address.
ip6 string
IPv6 server address.
objectCifsDomaincontrollerId string
an identifier for the resource with format {{server_name}}.
passwords string[]
Password for specified username.
port number
Port number of service. Port number 0 indicates automatic discovery.
scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
serverName string
Name of the server to connect to.
username string
User name to sign in with. Must have proper permissions for service.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
domain_name str
Fully qualified domain name (FQDN). E.g. 'EXAMPLE.COM'.
ip str
IPv4 server address.
ip6 str
IPv6 server address.
object_cifs_domaincontroller_id str
an identifier for the resource with format {{server_name}}.
passwords Sequence[str]
Password for specified username.
port float
Port number of service. Port number 0 indicates automatic discovery.
scopetype str
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
server_name str
Name of the server to connect to.
username str
User name to sign in with. Must have proper permissions for service.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
domainName String
Fully qualified domain name (FQDN). E.g. 'EXAMPLE.COM'.
ip String
IPv4 server address.
ip6 String
IPv6 server address.
objectCifsDomaincontrollerId String
an identifier for the resource with format {{server_name}}.
passwords List<String>
Password for specified username.
port Number
Port number of service. Port number 0 indicates automatic discovery.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
serverName String
Name of the server to connect to.
username String
User name to sign in with. Must have proper permissions for service.

Outputs

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

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

Look up Existing ObjectCifsDomaincontroller Resource

Get an existing ObjectCifsDomaincontroller 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?: ObjectCifsDomaincontrollerState, opts?: CustomResourceOptions): ObjectCifsDomaincontroller
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        domain_name: Optional[str] = None,
        ip: Optional[str] = None,
        ip6: Optional[str] = None,
        object_cifs_domaincontroller_id: Optional[str] = None,
        passwords: Optional[Sequence[str]] = None,
        port: Optional[float] = None,
        scopetype: Optional[str] = None,
        server_name: Optional[str] = None,
        username: Optional[str] = None) -> ObjectCifsDomaincontroller
func GetObjectCifsDomaincontroller(ctx *Context, name string, id IDInput, state *ObjectCifsDomaincontrollerState, opts ...ResourceOption) (*ObjectCifsDomaincontroller, error)
public static ObjectCifsDomaincontroller Get(string name, Input<string> id, ObjectCifsDomaincontrollerState? state, CustomResourceOptions? opts = null)
public static ObjectCifsDomaincontroller get(String name, Output<String> id, ObjectCifsDomaincontrollerState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:ObjectCifsDomaincontroller    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:
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
DomainName string
Fully qualified domain name (FQDN). E.g. 'EXAMPLE.COM'.
Ip string
IPv4 server address.
Ip6 string
IPv6 server address.
ObjectCifsDomaincontrollerId string
an identifier for the resource with format {{server_name}}.
Passwords List<string>
Password for specified username.
Port double
Port number of service. Port number 0 indicates automatic discovery.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
ServerName string
Name of the server to connect to.
Username string
User name to sign in with. Must have proper permissions for service.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
DomainName string
Fully qualified domain name (FQDN). E.g. 'EXAMPLE.COM'.
Ip string
IPv4 server address.
Ip6 string
IPv6 server address.
ObjectCifsDomaincontrollerId string
an identifier for the resource with format {{server_name}}.
Passwords []string
Password for specified username.
Port float64
Port number of service. Port number 0 indicates automatic discovery.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
ServerName string
Name of the server to connect to.
Username string
User name to sign in with. Must have proper permissions for service.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
domainName String
Fully qualified domain name (FQDN). E.g. 'EXAMPLE.COM'.
ip String
IPv4 server address.
ip6 String
IPv6 server address.
objectCifsDomaincontrollerId String
an identifier for the resource with format {{server_name}}.
passwords List<String>
Password for specified username.
port Double
Port number of service. Port number 0 indicates automatic discovery.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
serverName String
Name of the server to connect to.
username String
User name to sign in with. Must have proper permissions for service.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
domainName string
Fully qualified domain name (FQDN). E.g. 'EXAMPLE.COM'.
ip string
IPv4 server address.
ip6 string
IPv6 server address.
objectCifsDomaincontrollerId string
an identifier for the resource with format {{server_name}}.
passwords string[]
Password for specified username.
port number
Port number of service. Port number 0 indicates automatic discovery.
scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
serverName string
Name of the server to connect to.
username string
User name to sign in with. Must have proper permissions for service.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
domain_name str
Fully qualified domain name (FQDN). E.g. 'EXAMPLE.COM'.
ip str
IPv4 server address.
ip6 str
IPv6 server address.
object_cifs_domaincontroller_id str
an identifier for the resource with format {{server_name}}.
passwords Sequence[str]
Password for specified username.
port float
Port number of service. Port number 0 indicates automatic discovery.
scopetype str
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
server_name str
Name of the server to connect to.
username str
User name to sign in with. Must have proper permissions for service.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
domainName String
Fully qualified domain name (FQDN). E.g. 'EXAMPLE.COM'.
ip String
IPv4 server address.
ip6 String
IPv6 server address.
objectCifsDomaincontrollerId String
an identifier for the resource with format {{server_name}}.
passwords List<String>
Password for specified username.
port Number
Port number of service. Port number 0 indicates automatic discovery.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
serverName String
Name of the server to connect to.
username String
User name to sign in with. Must have proper permissions for service.

Import

ObjectCifs DomainController can be imported using any of these accepted formats:

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/objectCifsDomaincontroller:ObjectCifsDomaincontroller labelname {{server_name}}
Copy

$ unset “FORTIMANAGER_IMPORT_TABLE”

-> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

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

Package Details

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