1. Packages
  2. Fortios
  3. API Docs
  4. credentialstore
  5. Domaincontroller
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.credentialstore.Domaincontroller

Explore with Pulumi AI

fortios logo
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

    Define known domain controller servers. Applies to FortiOS Version 6.4.0,6.4.1,6.4.2,6.4.10,6.4.11,6.4.12,6.4.13,6.4.14,7.0.0.

    Create Domaincontroller Resource

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

    Constructor syntax

    new Domaincontroller(name: string, args?: DomaincontrollerArgs, opts?: CustomResourceOptions);
    @overload
    def Domaincontroller(resource_name: str,
                         args: Optional[DomaincontrollerArgs] = None,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def Domaincontroller(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         domain_name: Optional[str] = None,
                         hostname: Optional[str] = None,
                         ip: Optional[str] = None,
                         ip6: Optional[str] = None,
                         password: Optional[str] = None,
                         port: Optional[int] = None,
                         server_name: Optional[str] = None,
                         username: Optional[str] = None,
                         vdomparam: Optional[str] = None)
    func NewDomaincontroller(ctx *Context, name string, args *DomaincontrollerArgs, opts ...ResourceOption) (*Domaincontroller, error)
    public Domaincontroller(string name, DomaincontrollerArgs? args = null, CustomResourceOptions? opts = null)
    public Domaincontroller(String name, DomaincontrollerArgs args)
    public Domaincontroller(String name, DomaincontrollerArgs args, CustomResourceOptions options)
    
    type: fortios:credentialstore:Domaincontroller
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Example

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

    var fortiosDomaincontrollerResource = new Fortios.Credentialstore.Domaincontroller("fortiosDomaincontrollerResource", new()
    {
        DomainName = "string",
        Hostname = "string",
        Ip = "string",
        Ip6 = "string",
        Password = "string",
        Port = 0,
        ServerName = "string",
        Username = "string",
        Vdomparam = "string",
    });
    
    example, err := credentialstore.NewDomaincontroller(ctx, "fortiosDomaincontrollerResource", &credentialstore.DomaincontrollerArgs{
    	DomainName: pulumi.String("string"),
    	Hostname:   pulumi.String("string"),
    	Ip:         pulumi.String("string"),
    	Ip6:        pulumi.String("string"),
    	Password:   pulumi.String("string"),
    	Port:       pulumi.Int(0),
    	ServerName: pulumi.String("string"),
    	Username:   pulumi.String("string"),
    	Vdomparam:  pulumi.String("string"),
    })
    
    var fortiosDomaincontrollerResource = new Domaincontroller("fortiosDomaincontrollerResource", DomaincontrollerArgs.builder()        
        .domainName("string")
        .hostname("string")
        .ip("string")
        .ip6("string")
        .password("string")
        .port(0)
        .serverName("string")
        .username("string")
        .vdomparam("string")
        .build());
    
    fortios_domaincontroller_resource = fortios.credentialstore.Domaincontroller("fortiosDomaincontrollerResource",
        domain_name="string",
        hostname="string",
        ip="string",
        ip6="string",
        password="string",
        port=0,
        server_name="string",
        username="string",
        vdomparam="string")
    
    const fortiosDomaincontrollerResource = new fortios.credentialstore.Domaincontroller("fortiosDomaincontrollerResource", {
        domainName: "string",
        hostname: "string",
        ip: "string",
        ip6: "string",
        password: "string",
        port: 0,
        serverName: "string",
        username: "string",
        vdomparam: "string",
    });
    
    type: fortios:credentialstore:Domaincontroller
    properties:
        domainName: string
        hostname: string
        ip: string
        ip6: string
        password: string
        port: 0
        serverName: string
        username: string
        vdomparam: string
    

    Domaincontroller Resource Properties

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

    Inputs

    The Domaincontroller resource accepts the following input properties:

    DomainName string
    Fully qualified domain name (FQDN).
    Hostname string
    Hostname of the server to connect to.
    Ip string
    IPv4 server address.
    Ip6 string
    IPv6 server address.
    Password string
    Password for specified username.
    Port int
    Port number of service. Port number 0 indicates automatic discovery.
    ServerName string
    Name of the server to connect to.
    Username string
    User name to sign in with. Must have proper permissions for service.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    DomainName string
    Fully qualified domain name (FQDN).
    Hostname string
    Hostname of the server to connect to.
    Ip string
    IPv4 server address.
    Ip6 string
    IPv6 server address.
    Password string
    Password for specified username.
    Port int
    Port number of service. Port number 0 indicates automatic discovery.
    ServerName string
    Name of the server to connect to.
    Username string
    User name to sign in with. Must have proper permissions for service.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    domainName String
    Fully qualified domain name (FQDN).
    hostname String
    Hostname of the server to connect to.
    ip String
    IPv4 server address.
    ip6 String
    IPv6 server address.
    password String
    Password for specified username.
    port Integer
    Port number of service. Port number 0 indicates automatic discovery.
    serverName String
    Name of the server to connect to.
    username String
    User name to sign in with. Must have proper permissions for service.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    domainName string
    Fully qualified domain name (FQDN).
    hostname string
    Hostname of the server to connect to.
    ip string
    IPv4 server address.
    ip6 string
    IPv6 server address.
    password string
    Password for specified username.
    port number
    Port number of service. Port number 0 indicates automatic discovery.
    serverName string
    Name of the server to connect to.
    username string
    User name to sign in with. Must have proper permissions for service.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    domain_name str
    Fully qualified domain name (FQDN).
    hostname str
    Hostname of the server to connect to.
    ip str
    IPv4 server address.
    ip6 str
    IPv6 server address.
    password str
    Password for specified username.
    port int
    Port number of service. Port number 0 indicates automatic discovery.
    server_name str
    Name of the server to connect to.
    username str
    User name to sign in with. Must have proper permissions for service.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    domainName String
    Fully qualified domain name (FQDN).
    hostname String
    Hostname of the server to connect to.
    ip String
    IPv4 server address.
    ip6 String
    IPv6 server address.
    password String
    Password for specified username.
    port Number
    Port number of service. Port number 0 indicates automatic discovery.
    serverName String
    Name of the server to connect to.
    username String
    User name to sign in with. Must have proper permissions for service.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Domaincontroller 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 Domaincontroller Resource

    Get an existing Domaincontroller 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?: DomaincontrollerState, opts?: CustomResourceOptions): Domaincontroller
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            domain_name: Optional[str] = None,
            hostname: Optional[str] = None,
            ip: Optional[str] = None,
            ip6: Optional[str] = None,
            password: Optional[str] = None,
            port: Optional[int] = None,
            server_name: Optional[str] = None,
            username: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Domaincontroller
    func GetDomaincontroller(ctx *Context, name string, id IDInput, state *DomaincontrollerState, opts ...ResourceOption) (*Domaincontroller, error)
    public static Domaincontroller Get(string name, Input<string> id, DomaincontrollerState? state, CustomResourceOptions? opts = null)
    public static Domaincontroller get(String name, Output<String> id, DomaincontrollerState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    DomainName string
    Fully qualified domain name (FQDN).
    Hostname string
    Hostname of the server to connect to.
    Ip string
    IPv4 server address.
    Ip6 string
    IPv6 server address.
    Password string
    Password for specified username.
    Port int
    Port number of service. Port number 0 indicates automatic discovery.
    ServerName string
    Name of the server to connect to.
    Username string
    User name to sign in with. Must have proper permissions for service.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    DomainName string
    Fully qualified domain name (FQDN).
    Hostname string
    Hostname of the server to connect to.
    Ip string
    IPv4 server address.
    Ip6 string
    IPv6 server address.
    Password string
    Password for specified username.
    Port int
    Port number of service. Port number 0 indicates automatic discovery.
    ServerName string
    Name of the server to connect to.
    Username string
    User name to sign in with. Must have proper permissions for service.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    domainName String
    Fully qualified domain name (FQDN).
    hostname String
    Hostname of the server to connect to.
    ip String
    IPv4 server address.
    ip6 String
    IPv6 server address.
    password String
    Password for specified username.
    port Integer
    Port number of service. Port number 0 indicates automatic discovery.
    serverName String
    Name of the server to connect to.
    username String
    User name to sign in with. Must have proper permissions for service.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    domainName string
    Fully qualified domain name (FQDN).
    hostname string
    Hostname of the server to connect to.
    ip string
    IPv4 server address.
    ip6 string
    IPv6 server address.
    password string
    Password for specified username.
    port number
    Port number of service. Port number 0 indicates automatic discovery.
    serverName string
    Name of the server to connect to.
    username string
    User name to sign in with. Must have proper permissions for service.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    domain_name str
    Fully qualified domain name (FQDN).
    hostname str
    Hostname of the server to connect to.
    ip str
    IPv4 server address.
    ip6 str
    IPv6 server address.
    password str
    Password for specified username.
    port int
    Port number of service. Port number 0 indicates automatic discovery.
    server_name str
    Name of the server to connect to.
    username str
    User name to sign in with. Must have proper permissions for service.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    domainName String
    Fully qualified domain name (FQDN).
    hostname String
    Hostname of the server to connect to.
    ip String
    IPv4 server address.
    ip6 String
    IPv6 server address.
    password String
    Password for specified username.
    port Number
    Port number of service. Port number 0 indicates automatic discovery.
    serverName String
    Name of the server to connect to.
    username String
    User name to sign in with. Must have proper permissions for service.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Import

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

    $ pulumi import fortios:credentialstore/domaincontroller:Domaincontroller labelname {{server_name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:credentialstore/domaincontroller:Domaincontroller labelname {{server_name}}
    

    $ unset “FORTIOS_IMPORT_TABLE”

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

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse