Docs Packages
  1. Packages
  2. Fortios
  3. API Docs
  4. endpointcontrol
  5. Client
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.endpointcontrol.Client

Explore with Pulumi AI

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

    Configure endpoint control client lists. Applies to FortiOS Version <= 6.2.0.

    Create Client Resource

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

    Constructor syntax

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

@overload
def Client(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           ad_groups: Optional[str] = None,
           fosid: Optional[int] = None,
           ftcl_uid: Optional[str] = None,
           info: Optional[str] = None,
           src_ip: Optional[str] = None,
           src_mac: Optional[str] = None,
           vdomparam: Optional[str] = None)
    func NewClient(ctx *Context, name string, args *ClientArgs, opts ...ResourceOption) (*Client, error)
    public Client(string name, ClientArgs? args = null, CustomResourceOptions? opts = null)
    public Client(String name, ClientArgs args)
public Client(String name, ClientArgs args, CustomResourceOptions options)

    type: fortios:endpointcontrol:Client
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 ClientArgs
    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 ClientArgs
    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 ClientArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClientArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClientArgs
    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 clientResource = new Fortios.Endpointcontrol.Client("clientResource", new()
{
    AdGroups = "string",
    Fosid = 0,
    FtclUid = "string",
    Info = "string",
    SrcIp = "string",
    SrcMac = "string",
    Vdomparam = "string",
});

    example, err := endpointcontrol.NewClient(ctx, "clientResource", &endpointcontrol.ClientArgs{
	AdGroups:  pulumi.String("string"),
	Fosid:     pulumi.Int(0),
	FtclUid:   pulumi.String("string"),
	Info:      pulumi.String("string"),
	SrcIp:     pulumi.String("string"),
	SrcMac:    pulumi.String("string"),
	Vdomparam: pulumi.String("string"),
})

    var clientResource = new Client("clientResource", ClientArgs.builder()
    .adGroups("string")
    .fosid(0)
    .ftclUid("string")
    .info("string")
    .srcIp("string")
    .srcMac("string")
    .vdomparam("string")
    .build());

    client_resource = fortios.endpointcontrol.Client("clientResource",
    ad_groups="string",
    fosid=0,
    ftcl_uid="string",
    info="string",
    src_ip="string",
    src_mac="string",
    vdomparam="string")

    const clientResource = new fortios.endpointcontrol.Client("clientResource", {
    adGroups: "string",
    fosid: 0,
    ftclUid: "string",
    info: "string",
    srcIp: "string",
    srcMac: "string",
    vdomparam: "string",
});

    type: fortios:endpointcontrol:Client
properties:
    adGroups: string
    fosid: 0
    ftclUid: string
    info: string
    srcIp: string
    srcMac: string
    vdomparam: string

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

    AdGroups string
    Endpoint client AD logon groups.
    Fosid int
    Endpoint client ID.
    FtclUid string
    Endpoint FortiClient UID.
    Info string
    Endpoint client information.
    SrcIp string
    Endpoint client IP address.
    SrcMac string
    Endpoint client MAC address.
    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.
    AdGroups string
    Endpoint client AD logon groups.
    Fosid int
    Endpoint client ID.
    FtclUid string
    Endpoint FortiClient UID.
    Info string
    Endpoint client information.
    SrcIp string
    Endpoint client IP address.
    SrcMac string
    Endpoint client MAC address.
    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.
    adGroups String
    Endpoint client AD logon groups.
    fosid Integer
    Endpoint client ID.
    ftclUid String
    Endpoint FortiClient UID.
    info String
    Endpoint client information.
    srcIp String
    Endpoint client IP address.
    srcMac String
    Endpoint client MAC address.
    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.
    adGroups string
    Endpoint client AD logon groups.
    fosid number
    Endpoint client ID.
    ftclUid string
    Endpoint FortiClient UID.
    info string
    Endpoint client information.
    srcIp string
    Endpoint client IP address.
    srcMac string
    Endpoint client MAC address.
    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.
    ad_groups str
    Endpoint client AD logon groups.
    fosid int
    Endpoint client ID.
    ftcl_uid str
    Endpoint FortiClient UID.
    info str
    Endpoint client information.
    src_ip str
    Endpoint client IP address.
    src_mac str
    Endpoint client MAC address.
    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.
    adGroups String
    Endpoint client AD logon groups.
    fosid Number
    Endpoint client ID.
    ftclUid String
    Endpoint FortiClient UID.
    info String
    Endpoint client information.
    srcIp String
    Endpoint client IP address.
    srcMac String
    Endpoint client MAC address.
    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 Client 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 Client Resource

    Get an existing Client 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?: ClientState, opts?: CustomResourceOptions): Client
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ad_groups: Optional[str] = None,
        fosid: Optional[int] = None,
        ftcl_uid: Optional[str] = None,
        info: Optional[str] = None,
        src_ip: Optional[str] = None,
        src_mac: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Client
    func GetClient(ctx *Context, name string, id IDInput, state *ClientState, opts ...ResourceOption) (*Client, error)
    public static Client Get(string name, Input<string> id, ClientState? state, CustomResourceOptions? opts = null)
    public static Client get(String name, Output<String> id, ClientState 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:
    AdGroups string
    Endpoint client AD logon groups.
    Fosid int
    Endpoint client ID.
    FtclUid string
    Endpoint FortiClient UID.
    Info string
    Endpoint client information.
    SrcIp string
    Endpoint client IP address.
    SrcMac string
    Endpoint client MAC address.
    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.
    AdGroups string
    Endpoint client AD logon groups.
    Fosid int
    Endpoint client ID.
    FtclUid string
    Endpoint FortiClient UID.
    Info string
    Endpoint client information.
    SrcIp string
    Endpoint client IP address.
    SrcMac string
    Endpoint client MAC address.
    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.
    adGroups String
    Endpoint client AD logon groups.
    fosid Integer
    Endpoint client ID.
    ftclUid String
    Endpoint FortiClient UID.
    info String
    Endpoint client information.
    srcIp String
    Endpoint client IP address.
    srcMac String
    Endpoint client MAC address.
    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.
    adGroups string
    Endpoint client AD logon groups.
    fosid number
    Endpoint client ID.
    ftclUid string
    Endpoint FortiClient UID.
    info string
    Endpoint client information.
    srcIp string
    Endpoint client IP address.
    srcMac string
    Endpoint client MAC address.
    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.
    ad_groups str
    Endpoint client AD logon groups.
    fosid int
    Endpoint client ID.
    ftcl_uid str
    Endpoint FortiClient UID.
    info str
    Endpoint client information.
    src_ip str
    Endpoint client IP address.
    src_mac str
    Endpoint client MAC address.
    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.
    adGroups String
    Endpoint client AD logon groups.
    fosid Number
    Endpoint client ID.
    ftclUid String
    Endpoint FortiClient UID.
    info String
    Endpoint client information.
    srcIp String
    Endpoint client IP address.
    srcMac String
    Endpoint client MAC address.
    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 Client can be imported using any of these accepted formats:

    $ pulumi import fortios:endpointcontrol/client:Client labelname {{fosid}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:endpointcontrol/client:Client labelname {{fosid}}

    $ 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
    pulumiverse/pulumi-fortios