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

fortios.endpointcontrol.Registeredforticlient

Explore with Pulumi AI

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

    Registered FortiClient list. Applies to FortiOS Version <= 6.2.0.

    Create Registeredforticlient Resource

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

    Constructor syntax

    new Registeredforticlient(name: string, args?: RegisteredforticlientArgs, opts?: CustomResourceOptions);
    @overload
    def Registeredforticlient(resource_name: str,
                              args: Optional[RegisteredforticlientArgs] = None,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Registeredforticlient(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              flag: Optional[int] = None,
                              ip: Optional[str] = None,
                              mac: Optional[str] = None,
                              reg_fortigate: Optional[str] = None,
                              status: Optional[int] = None,
                              uid: Optional[str] = None,
                              vdom: Optional[str] = None,
                              vdomparam: Optional[str] = None)
    func NewRegisteredforticlient(ctx *Context, name string, args *RegisteredforticlientArgs, opts ...ResourceOption) (*Registeredforticlient, error)
    public Registeredforticlient(string name, RegisteredforticlientArgs? args = null, CustomResourceOptions? opts = null)
    public Registeredforticlient(String name, RegisteredforticlientArgs args)
    public Registeredforticlient(String name, RegisteredforticlientArgs args, CustomResourceOptions options)
    
    type: fortios:endpointcontrol:Registeredforticlient
    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 RegisteredforticlientArgs
    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 RegisteredforticlientArgs
    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 RegisteredforticlientArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RegisteredforticlientArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RegisteredforticlientArgs
    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 registeredforticlientResource = new Fortios.Endpointcontrol.Registeredforticlient("registeredforticlientResource", new()
    {
        Flag = 0,
        Ip = "string",
        Mac = "string",
        RegFortigate = "string",
        Status = 0,
        Uid = "string",
        Vdom = "string",
        Vdomparam = "string",
    });
    
    example, err := endpointcontrol.NewRegisteredforticlient(ctx, "registeredforticlientResource", &endpointcontrol.RegisteredforticlientArgs{
    	Flag:         pulumi.Int(0),
    	Ip:           pulumi.String("string"),
    	Mac:          pulumi.String("string"),
    	RegFortigate: pulumi.String("string"),
    	Status:       pulumi.Int(0),
    	Uid:          pulumi.String("string"),
    	Vdom:         pulumi.String("string"),
    	Vdomparam:    pulumi.String("string"),
    })
    
    var registeredforticlientResource = new Registeredforticlient("registeredforticlientResource", RegisteredforticlientArgs.builder()
        .flag(0)
        .ip("string")
        .mac("string")
        .regFortigate("string")
        .status(0)
        .uid("string")
        .vdom("string")
        .vdomparam("string")
        .build());
    
    registeredforticlient_resource = fortios.endpointcontrol.Registeredforticlient("registeredforticlientResource",
        flag=0,
        ip="string",
        mac="string",
        reg_fortigate="string",
        status=0,
        uid="string",
        vdom="string",
        vdomparam="string")
    
    const registeredforticlientResource = new fortios.endpointcontrol.Registeredforticlient("registeredforticlientResource", {
        flag: 0,
        ip: "string",
        mac: "string",
        regFortigate: "string",
        status: 0,
        uid: "string",
        vdom: "string",
        vdomparam: "string",
    });
    
    type: fortios:endpointcontrol:Registeredforticlient
    properties:
        flag: 0
        ip: string
        mac: string
        regFortigate: string
        status: 0
        uid: string
        vdom: string
        vdomparam: string
    

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

    Flag int
    FortiClient registration flag.
    Ip string
    Endpoint IP address.
    Mac string
    Endpoint MAC address.
    RegFortigate string
    Registering FortiGate SN.
    Status int
    FortiClient registration status.
    Uid string
    FortiClient UID.
    Vdom string
    Registering vdom.
    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.
    Flag int
    FortiClient registration flag.
    Ip string
    Endpoint IP address.
    Mac string
    Endpoint MAC address.
    RegFortigate string
    Registering FortiGate SN.
    Status int
    FortiClient registration status.
    Uid string
    FortiClient UID.
    Vdom string
    Registering vdom.
    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.
    flag Integer
    FortiClient registration flag.
    ip String
    Endpoint IP address.
    mac String
    Endpoint MAC address.
    regFortigate String
    Registering FortiGate SN.
    status Integer
    FortiClient registration status.
    uid String
    FortiClient UID.
    vdom String
    Registering vdom.
    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.
    flag number
    FortiClient registration flag.
    ip string
    Endpoint IP address.
    mac string
    Endpoint MAC address.
    regFortigate string
    Registering FortiGate SN.
    status number
    FortiClient registration status.
    uid string
    FortiClient UID.
    vdom string
    Registering vdom.
    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.
    flag int
    FortiClient registration flag.
    ip str
    Endpoint IP address.
    mac str
    Endpoint MAC address.
    reg_fortigate str
    Registering FortiGate SN.
    status int
    FortiClient registration status.
    uid str
    FortiClient UID.
    vdom str
    Registering vdom.
    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.
    flag Number
    FortiClient registration flag.
    ip String
    Endpoint IP address.
    mac String
    Endpoint MAC address.
    regFortigate String
    Registering FortiGate SN.
    status Number
    FortiClient registration status.
    uid String
    FortiClient UID.
    vdom String
    Registering vdom.
    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 Registeredforticlient 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 Registeredforticlient Resource

    Get an existing Registeredforticlient 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?: RegisteredforticlientState, opts?: CustomResourceOptions): Registeredforticlient
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            flag: Optional[int] = None,
            ip: Optional[str] = None,
            mac: Optional[str] = None,
            reg_fortigate: Optional[str] = None,
            status: Optional[int] = None,
            uid: Optional[str] = None,
            vdom: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Registeredforticlient
    func GetRegisteredforticlient(ctx *Context, name string, id IDInput, state *RegisteredforticlientState, opts ...ResourceOption) (*Registeredforticlient, error)
    public static Registeredforticlient Get(string name, Input<string> id, RegisteredforticlientState? state, CustomResourceOptions? opts = null)
    public static Registeredforticlient get(String name, Output<String> id, RegisteredforticlientState 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:
    Flag int
    FortiClient registration flag.
    Ip string
    Endpoint IP address.
    Mac string
    Endpoint MAC address.
    RegFortigate string
    Registering FortiGate SN.
    Status int
    FortiClient registration status.
    Uid string
    FortiClient UID.
    Vdom string
    Registering vdom.
    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.
    Flag int
    FortiClient registration flag.
    Ip string
    Endpoint IP address.
    Mac string
    Endpoint MAC address.
    RegFortigate string
    Registering FortiGate SN.
    Status int
    FortiClient registration status.
    Uid string
    FortiClient UID.
    Vdom string
    Registering vdom.
    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.
    flag Integer
    FortiClient registration flag.
    ip String
    Endpoint IP address.
    mac String
    Endpoint MAC address.
    regFortigate String
    Registering FortiGate SN.
    status Integer
    FortiClient registration status.
    uid String
    FortiClient UID.
    vdom String
    Registering vdom.
    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.
    flag number
    FortiClient registration flag.
    ip string
    Endpoint IP address.
    mac string
    Endpoint MAC address.
    regFortigate string
    Registering FortiGate SN.
    status number
    FortiClient registration status.
    uid string
    FortiClient UID.
    vdom string
    Registering vdom.
    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.
    flag int
    FortiClient registration flag.
    ip str
    Endpoint IP address.
    mac str
    Endpoint MAC address.
    reg_fortigate str
    Registering FortiGate SN.
    status int
    FortiClient registration status.
    uid str
    FortiClient UID.
    vdom str
    Registering vdom.
    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.
    flag Number
    FortiClient registration flag.
    ip String
    Endpoint IP address.
    mac String
    Endpoint MAC address.
    regFortigate String
    Registering FortiGate SN.
    status Number
    FortiClient registration status.
    uid String
    FortiClient UID.
    vdom String
    Registering vdom.
    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 RegisteredForticlient can be imported using any of these accepted formats:

    $ pulumi import fortios:endpointcontrol/registeredforticlient:Registeredforticlient labelname {{uid}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:endpointcontrol/registeredforticlient:Registeredforticlient labelname {{uid}}
    

    $ 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