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

fortios.endpointcontrol.Forticlientems

Explore with Pulumi AI

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

    Configure FortiClient Enterprise Management Server (EMS) entries. Applies to FortiOS Version <= 6.2.0.

    Create Forticlientems Resource

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

    Constructor syntax

    new Forticlientems(name: string, args: ForticlientemsArgs, opts?: CustomResourceOptions);
    @overload
    def Forticlientems(resource_name: str,
                       args: ForticlientemsArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def Forticlientems(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       address: Optional[str] = None,
                       admin_username: Optional[str] = None,
                       serial_number: Optional[str] = None,
                       admin_password: Optional[str] = None,
                       admin_type: Optional[str] = None,
                       https_port: Optional[int] = None,
                       listen_port: Optional[int] = None,
                       name: Optional[str] = None,
                       rest_api_auth: Optional[str] = None,
                       upload_port: Optional[int] = None,
                       vdomparam: Optional[str] = None)
    func NewForticlientems(ctx *Context, name string, args ForticlientemsArgs, opts ...ResourceOption) (*Forticlientems, error)
    public Forticlientems(string name, ForticlientemsArgs args, CustomResourceOptions? opts = null)
    public Forticlientems(String name, ForticlientemsArgs args)
    public Forticlientems(String name, ForticlientemsArgs args, CustomResourceOptions options)
    
    type: fortios:endpointcontrol:Forticlientems
    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 ForticlientemsArgs
    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 ForticlientemsArgs
    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 ForticlientemsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ForticlientemsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ForticlientemsArgs
    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 forticlientemsResource = new Fortios.Endpointcontrol.Forticlientems("forticlientemsResource", new()
    {
        Address = "string",
        AdminUsername = "string",
        SerialNumber = "string",
        AdminPassword = "string",
        AdminType = "string",
        HttpsPort = 0,
        ListenPort = 0,
        Name = "string",
        RestApiAuth = "string",
        UploadPort = 0,
        Vdomparam = "string",
    });
    
    example, err := endpointcontrol.NewForticlientems(ctx, "forticlientemsResource", &endpointcontrol.ForticlientemsArgs{
    	Address:       pulumi.String("string"),
    	AdminUsername: pulumi.String("string"),
    	SerialNumber:  pulumi.String("string"),
    	AdminPassword: pulumi.String("string"),
    	AdminType:     pulumi.String("string"),
    	HttpsPort:     pulumi.Int(0),
    	ListenPort:    pulumi.Int(0),
    	Name:          pulumi.String("string"),
    	RestApiAuth:   pulumi.String("string"),
    	UploadPort:    pulumi.Int(0),
    	Vdomparam:     pulumi.String("string"),
    })
    
    var forticlientemsResource = new Forticlientems("forticlientemsResource", ForticlientemsArgs.builder()        
        .address("string")
        .adminUsername("string")
        .serialNumber("string")
        .adminPassword("string")
        .adminType("string")
        .httpsPort(0)
        .listenPort(0)
        .name("string")
        .restApiAuth("string")
        .uploadPort(0)
        .vdomparam("string")
        .build());
    
    forticlientems_resource = fortios.endpointcontrol.Forticlientems("forticlientemsResource",
        address="string",
        admin_username="string",
        serial_number="string",
        admin_password="string",
        admin_type="string",
        https_port=0,
        listen_port=0,
        name="string",
        rest_api_auth="string",
        upload_port=0,
        vdomparam="string")
    
    const forticlientemsResource = new fortios.endpointcontrol.Forticlientems("forticlientemsResource", {
        address: "string",
        adminUsername: "string",
        serialNumber: "string",
        adminPassword: "string",
        adminType: "string",
        httpsPort: 0,
        listenPort: 0,
        name: "string",
        restApiAuth: "string",
        uploadPort: 0,
        vdomparam: "string",
    });
    
    type: fortios:endpointcontrol:Forticlientems
    properties:
        address: string
        adminPassword: string
        adminType: string
        adminUsername: string
        httpsPort: 0
        listenPort: 0
        name: string
        restApiAuth: string
        serialNumber: string
        uploadPort: 0
        vdomparam: string
    

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

    Address string
    Firewall address name.
    AdminUsername string
    FortiClient EMS admin username.
    SerialNumber string
    FortiClient EMS Serial Number.
    AdminPassword string
    FortiClient EMS admin password.
    AdminType string
    FortiClient EMS admin type. Valid values: Windows, LDAP.
    HttpsPort int
    FortiClient EMS HTTPS access port number. (1 - 65535, default: 443).
    ListenPort int
    FortiClient EMS telemetry listen port number. (1 - 65535, default: 8013).
    Name string
    FortiClient Enterprise Management Server (EMS) name.
    RestApiAuth string
    FortiClient EMS REST API authentication. Valid values: disable, userpass.
    UploadPort int
    FortiClient EMS telemetry upload port number. (1 - 65535, default: 8014).
    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.
    Address string
    Firewall address name.
    AdminUsername string
    FortiClient EMS admin username.
    SerialNumber string
    FortiClient EMS Serial Number.
    AdminPassword string
    FortiClient EMS admin password.
    AdminType string
    FortiClient EMS admin type. Valid values: Windows, LDAP.
    HttpsPort int
    FortiClient EMS HTTPS access port number. (1 - 65535, default: 443).
    ListenPort int
    FortiClient EMS telemetry listen port number. (1 - 65535, default: 8013).
    Name string
    FortiClient Enterprise Management Server (EMS) name.
    RestApiAuth string
    FortiClient EMS REST API authentication. Valid values: disable, userpass.
    UploadPort int
    FortiClient EMS telemetry upload port number. (1 - 65535, default: 8014).
    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.
    address String
    Firewall address name.
    adminUsername String
    FortiClient EMS admin username.
    serialNumber String
    FortiClient EMS Serial Number.
    adminPassword String
    FortiClient EMS admin password.
    adminType String
    FortiClient EMS admin type. Valid values: Windows, LDAP.
    httpsPort Integer
    FortiClient EMS HTTPS access port number. (1 - 65535, default: 443).
    listenPort Integer
    FortiClient EMS telemetry listen port number. (1 - 65535, default: 8013).
    name String
    FortiClient Enterprise Management Server (EMS) name.
    restApiAuth String
    FortiClient EMS REST API authentication. Valid values: disable, userpass.
    uploadPort Integer
    FortiClient EMS telemetry upload port number. (1 - 65535, default: 8014).
    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.
    address string
    Firewall address name.
    adminUsername string
    FortiClient EMS admin username.
    serialNumber string
    FortiClient EMS Serial Number.
    adminPassword string
    FortiClient EMS admin password.
    adminType string
    FortiClient EMS admin type. Valid values: Windows, LDAP.
    httpsPort number
    FortiClient EMS HTTPS access port number. (1 - 65535, default: 443).
    listenPort number
    FortiClient EMS telemetry listen port number. (1 - 65535, default: 8013).
    name string
    FortiClient Enterprise Management Server (EMS) name.
    restApiAuth string
    FortiClient EMS REST API authentication. Valid values: disable, userpass.
    uploadPort number
    FortiClient EMS telemetry upload port number. (1 - 65535, default: 8014).
    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.
    address str
    Firewall address name.
    admin_username str
    FortiClient EMS admin username.
    serial_number str
    FortiClient EMS Serial Number.
    admin_password str
    FortiClient EMS admin password.
    admin_type str
    FortiClient EMS admin type. Valid values: Windows, LDAP.
    https_port int
    FortiClient EMS HTTPS access port number. (1 - 65535, default: 443).
    listen_port int
    FortiClient EMS telemetry listen port number. (1 - 65535, default: 8013).
    name str
    FortiClient Enterprise Management Server (EMS) name.
    rest_api_auth str
    FortiClient EMS REST API authentication. Valid values: disable, userpass.
    upload_port int
    FortiClient EMS telemetry upload port number. (1 - 65535, default: 8014).
    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.
    address String
    Firewall address name.
    adminUsername String
    FortiClient EMS admin username.
    serialNumber String
    FortiClient EMS Serial Number.
    adminPassword String
    FortiClient EMS admin password.
    adminType String
    FortiClient EMS admin type. Valid values: Windows, LDAP.
    httpsPort Number
    FortiClient EMS HTTPS access port number. (1 - 65535, default: 443).
    listenPort Number
    FortiClient EMS telemetry listen port number. (1 - 65535, default: 8013).
    name String
    FortiClient Enterprise Management Server (EMS) name.
    restApiAuth String
    FortiClient EMS REST API authentication. Valid values: disable, userpass.
    uploadPort Number
    FortiClient EMS telemetry upload port number. (1 - 65535, default: 8014).
    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 Forticlientems 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 Forticlientems Resource

    Get an existing Forticlientems 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?: ForticlientemsState, opts?: CustomResourceOptions): Forticlientems
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            address: Optional[str] = None,
            admin_password: Optional[str] = None,
            admin_type: Optional[str] = None,
            admin_username: Optional[str] = None,
            https_port: Optional[int] = None,
            listen_port: Optional[int] = None,
            name: Optional[str] = None,
            rest_api_auth: Optional[str] = None,
            serial_number: Optional[str] = None,
            upload_port: Optional[int] = None,
            vdomparam: Optional[str] = None) -> Forticlientems
    func GetForticlientems(ctx *Context, name string, id IDInput, state *ForticlientemsState, opts ...ResourceOption) (*Forticlientems, error)
    public static Forticlientems Get(string name, Input<string> id, ForticlientemsState? state, CustomResourceOptions? opts = null)
    public static Forticlientems get(String name, Output<String> id, ForticlientemsState 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:
    Address string
    Firewall address name.
    AdminPassword string
    FortiClient EMS admin password.
    AdminType string
    FortiClient EMS admin type. Valid values: Windows, LDAP.
    AdminUsername string
    FortiClient EMS admin username.
    HttpsPort int
    FortiClient EMS HTTPS access port number. (1 - 65535, default: 443).
    ListenPort int
    FortiClient EMS telemetry listen port number. (1 - 65535, default: 8013).
    Name string
    FortiClient Enterprise Management Server (EMS) name.
    RestApiAuth string
    FortiClient EMS REST API authentication. Valid values: disable, userpass.
    SerialNumber string
    FortiClient EMS Serial Number.
    UploadPort int
    FortiClient EMS telemetry upload port number. (1 - 65535, default: 8014).
    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.
    Address string
    Firewall address name.
    AdminPassword string
    FortiClient EMS admin password.
    AdminType string
    FortiClient EMS admin type. Valid values: Windows, LDAP.
    AdminUsername string
    FortiClient EMS admin username.
    HttpsPort int
    FortiClient EMS HTTPS access port number. (1 - 65535, default: 443).
    ListenPort int
    FortiClient EMS telemetry listen port number. (1 - 65535, default: 8013).
    Name string
    FortiClient Enterprise Management Server (EMS) name.
    RestApiAuth string
    FortiClient EMS REST API authentication. Valid values: disable, userpass.
    SerialNumber string
    FortiClient EMS Serial Number.
    UploadPort int
    FortiClient EMS telemetry upload port number. (1 - 65535, default: 8014).
    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.
    address String
    Firewall address name.
    adminPassword String
    FortiClient EMS admin password.
    adminType String
    FortiClient EMS admin type. Valid values: Windows, LDAP.
    adminUsername String
    FortiClient EMS admin username.
    httpsPort Integer
    FortiClient EMS HTTPS access port number. (1 - 65535, default: 443).
    listenPort Integer
    FortiClient EMS telemetry listen port number. (1 - 65535, default: 8013).
    name String
    FortiClient Enterprise Management Server (EMS) name.
    restApiAuth String
    FortiClient EMS REST API authentication. Valid values: disable, userpass.
    serialNumber String
    FortiClient EMS Serial Number.
    uploadPort Integer
    FortiClient EMS telemetry upload port number. (1 - 65535, default: 8014).
    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.
    address string
    Firewall address name.
    adminPassword string
    FortiClient EMS admin password.
    adminType string
    FortiClient EMS admin type. Valid values: Windows, LDAP.
    adminUsername string
    FortiClient EMS admin username.
    httpsPort number
    FortiClient EMS HTTPS access port number. (1 - 65535, default: 443).
    listenPort number
    FortiClient EMS telemetry listen port number. (1 - 65535, default: 8013).
    name string
    FortiClient Enterprise Management Server (EMS) name.
    restApiAuth string
    FortiClient EMS REST API authentication. Valid values: disable, userpass.
    serialNumber string
    FortiClient EMS Serial Number.
    uploadPort number
    FortiClient EMS telemetry upload port number. (1 - 65535, default: 8014).
    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.
    address str
    Firewall address name.
    admin_password str
    FortiClient EMS admin password.
    admin_type str
    FortiClient EMS admin type. Valid values: Windows, LDAP.
    admin_username str
    FortiClient EMS admin username.
    https_port int
    FortiClient EMS HTTPS access port number. (1 - 65535, default: 443).
    listen_port int
    FortiClient EMS telemetry listen port number. (1 - 65535, default: 8013).
    name str
    FortiClient Enterprise Management Server (EMS) name.
    rest_api_auth str
    FortiClient EMS REST API authentication. Valid values: disable, userpass.
    serial_number str
    FortiClient EMS Serial Number.
    upload_port int
    FortiClient EMS telemetry upload port number. (1 - 65535, default: 8014).
    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.
    address String
    Firewall address name.
    adminPassword String
    FortiClient EMS admin password.
    adminType String
    FortiClient EMS admin type. Valid values: Windows, LDAP.
    adminUsername String
    FortiClient EMS admin username.
    httpsPort Number
    FortiClient EMS HTTPS access port number. (1 - 65535, default: 443).
    listenPort Number
    FortiClient EMS telemetry listen port number. (1 - 65535, default: 8013).
    name String
    FortiClient Enterprise Management Server (EMS) name.
    restApiAuth String
    FortiClient EMS REST API authentication. Valid values: disable, userpass.
    serialNumber String
    FortiClient EMS Serial Number.
    uploadPort Number
    FortiClient EMS telemetry upload port number. (1 - 65535, default: 8014).
    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

    EndpointControl ForticlientEms can be imported using any of these accepted formats:

    $ pulumi import fortios:endpointcontrol/forticlientems:Forticlientems labelname {{name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:endpointcontrol/forticlientems:Forticlientems labelname {{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