Fortios v0.0.6, Jul 9 24

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.vpn/ssl.Client

Explore with Pulumi AI

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

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,
           certificate: Optional[str] = None,
           class_id: Optional[int] = None,
           comment: Optional[str] = None,
           distance: Optional[int] = None,
           interface: Optional[str] = None,
           ipv4_subnets: Optional[str] = None,
           ipv6_subnets: Optional[str] = None,
           name: Optional[str] = None,
           peer: Optional[str] = None,
           port: Optional[int] = None,
           priority: Optional[int] = None,
           psk: Optional[str] = None,
           realm: Optional[str] = None,
           server: Optional[str] = None,
           source_ip: Optional[str] = None,
           status: Optional[str] = None,
           user: 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:vpn/ssl/client: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.

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Client resource accepts the following input properties:

Certificate string: Certificate to offer to SSL-VPN server if it requests one.
ClassId int: Traffic class ID.
Comment string: Comment.
Distance int: Distance for routes added by SSL-VPN (1 - 255).
Interface string: SSL interface to send/receive traffic over.
Ipv4Subnets string: IPv4 subnets that the client is protecting.
Ipv6Subnets string: IPv6 subnets that the client is protecting.
Name string: SSL-VPN tunnel name.
Peer string: Authenticate peer's certificate with the peer/peergrp.
Port int: SSL-VPN server port.
Priority int: Priority for routes added by SSL-VPN. On FortiOS versions 7.0.1-7.0.3: 0 - 4294967295. On FortiOS versions >= 7.0.4: 1 - 65535.
Psk string: Pre-shared secret to authenticate with the server (ASCII string or hexadecimal encoded with a leading 0x).
Realm string: Realm name configured on SSL-VPN server.
Server string: IPv4, IPv6 or DNS address of the SSL-VPN server.
SourceIp string: IPv4 or IPv6 address to use as a source for the SSL-VPN connection to the server.
Status string: Enable/disable this SSL-VPN client configuration. Valid values: enable, disable.
User string: Username to offer to the peer to authenticate the client.
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.

Certificate string: Certificate to offer to SSL-VPN server if it requests one.
ClassId int: Traffic class ID.
Comment string: Comment.
Distance int: Distance for routes added by SSL-VPN (1 - 255).
Interface string: SSL interface to send/receive traffic over.
Ipv4Subnets string: IPv4 subnets that the client is protecting.
Ipv6Subnets string: IPv6 subnets that the client is protecting.
Name string: SSL-VPN tunnel name.
Peer string: Authenticate peer's certificate with the peer/peergrp.
Port int: SSL-VPN server port.
Priority int: Priority for routes added by SSL-VPN. On FortiOS versions 7.0.1-7.0.3: 0 - 4294967295. On FortiOS versions >= 7.0.4: 1 - 65535.
Psk string: Pre-shared secret to authenticate with the server (ASCII string or hexadecimal encoded with a leading 0x).
Realm string: Realm name configured on SSL-VPN server.
Server string: IPv4, IPv6 or DNS address of the SSL-VPN server.
SourceIp string: IPv4 or IPv6 address to use as a source for the SSL-VPN connection to the server.
Status string: Enable/disable this SSL-VPN client configuration. Valid values: enable, disable.
User string: Username to offer to the peer to authenticate the client.
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.

certificate String: Certificate to offer to SSL-VPN server if it requests one.
classId Integer: Traffic class ID.
comment String: Comment.
distance Integer: Distance for routes added by SSL-VPN (1 - 255).
interface_ String: SSL interface to send/receive traffic over.
ipv4Subnets String: IPv4 subnets that the client is protecting.
ipv6Subnets String: IPv6 subnets that the client is protecting.
name String: SSL-VPN tunnel name.
peer String: Authenticate peer's certificate with the peer/peergrp.
port Integer: SSL-VPN server port.
priority Integer: Priority for routes added by SSL-VPN. On FortiOS versions 7.0.1-7.0.3: 0 - 4294967295. On FortiOS versions >= 7.0.4: 1 - 65535.
psk String: Pre-shared secret to authenticate with the server (ASCII string or hexadecimal encoded with a leading 0x).
realm String: Realm name configured on SSL-VPN server.
server String: IPv4, IPv6 or DNS address of the SSL-VPN server.
sourceIp String: IPv4 or IPv6 address to use as a source for the SSL-VPN connection to the server.
status String: Enable/disable this SSL-VPN client configuration. Valid values: enable, disable.
user String: Username to offer to the peer to authenticate the client.
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.

certificate string: Certificate to offer to SSL-VPN server if it requests one.
classId number: Traffic class ID.
comment string: Comment.
distance number: Distance for routes added by SSL-VPN (1 - 255).
interface string: SSL interface to send/receive traffic over.
ipv4Subnets string: IPv4 subnets that the client is protecting.
ipv6Subnets string: IPv6 subnets that the client is protecting.
name string: SSL-VPN tunnel name.
peer string: Authenticate peer's certificate with the peer/peergrp.
port number: SSL-VPN server port.
priority number: Priority for routes added by SSL-VPN. On FortiOS versions 7.0.1-7.0.3: 0 - 4294967295. On FortiOS versions >= 7.0.4: 1 - 65535.
psk string: Pre-shared secret to authenticate with the server (ASCII string or hexadecimal encoded with a leading 0x).
realm string: Realm name configured on SSL-VPN server.
server string: IPv4, IPv6 or DNS address of the SSL-VPN server.
sourceIp string: IPv4 or IPv6 address to use as a source for the SSL-VPN connection to the server.
status string: Enable/disable this SSL-VPN client configuration. Valid values: enable, disable.
user string: Username to offer to the peer to authenticate the client.
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.

certificate str: Certificate to offer to SSL-VPN server if it requests one.
class_id int: Traffic class ID.
comment str: Comment.
distance int: Distance for routes added by SSL-VPN (1 - 255).
interface str: SSL interface to send/receive traffic over.
ipv4_subnets str: IPv4 subnets that the client is protecting.
ipv6_subnets str: IPv6 subnets that the client is protecting.
name str: SSL-VPN tunnel name.
peer str: Authenticate peer's certificate with the peer/peergrp.
port int: SSL-VPN server port.
priority int: Priority for routes added by SSL-VPN. On FortiOS versions 7.0.1-7.0.3: 0 - 4294967295. On FortiOS versions >= 7.0.4: 1 - 65535.
psk str: Pre-shared secret to authenticate with the server (ASCII string or hexadecimal encoded with a leading 0x).
realm str: Realm name configured on SSL-VPN server.
server str: IPv4, IPv6 or DNS address of the SSL-VPN server.
source_ip str: IPv4 or IPv6 address to use as a source for the SSL-VPN connection to the server.
status str: Enable/disable this SSL-VPN client configuration. Valid values: enable, disable.
user str: Username to offer to the peer to authenticate the client.
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.

certificate String: Certificate to offer to SSL-VPN server if it requests one.
classId Number: Traffic class ID.
comment String: Comment.
distance Number: Distance for routes added by SSL-VPN (1 - 255).
interface String: SSL interface to send/receive traffic over.
ipv4Subnets String: IPv4 subnets that the client is protecting.
ipv6Subnets String: IPv6 subnets that the client is protecting.
name String: SSL-VPN tunnel name.
peer String: Authenticate peer's certificate with the peer/peergrp.
port Number: SSL-VPN server port.
priority Number: Priority for routes added by SSL-VPN. On FortiOS versions 7.0.1-7.0.3: 0 - 4294967295. On FortiOS versions >= 7.0.4: 1 - 65535.
psk String: Pre-shared secret to authenticate with the server (ASCII string or hexadecimal encoded with a leading 0x).
realm String: Realm name configured on SSL-VPN server.
server String: IPv4, IPv6 or DNS address of the SSL-VPN server.
sourceIp String: IPv4 or IPv6 address to use as a source for the SSL-VPN connection to the server.
status String: Enable/disable this SSL-VPN client configuration. Valid values: enable, disable.
user String: Username to offer to the peer to authenticate the client.
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,
        certificate: Optional[str] = None,
        class_id: Optional[int] = None,
        comment: Optional[str] = None,
        distance: Optional[int] = None,
        interface: Optional[str] = None,
        ipv4_subnets: Optional[str] = None,
        ipv6_subnets: Optional[str] = None,
        name: Optional[str] = None,
        peer: Optional[str] = None,
        port: Optional[int] = None,
        priority: Optional[int] = None,
        psk: Optional[str] = None,
        realm: Optional[str] = None,
        server: Optional[str] = None,
        source_ip: Optional[str] = None,
        status: Optional[str] = None,
        user: 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:

Certificate string: Certificate to offer to SSL-VPN server if it requests one.
ClassId int: Traffic class ID.
Comment string: Comment.
Distance int: Distance for routes added by SSL-VPN (1 - 255).
Interface string: SSL interface to send/receive traffic over.
Ipv4Subnets string: IPv4 subnets that the client is protecting.
Ipv6Subnets string: IPv6 subnets that the client is protecting.
Name string: SSL-VPN tunnel name.
Peer string: Authenticate peer's certificate with the peer/peergrp.
Port int: SSL-VPN server port.
Priority int: Priority for routes added by SSL-VPN. On FortiOS versions 7.0.1-7.0.3: 0 - 4294967295. On FortiOS versions >= 7.0.4: 1 - 65535.
Psk string: Pre-shared secret to authenticate with the server (ASCII string or hexadecimal encoded with a leading 0x).
Realm string: Realm name configured on SSL-VPN server.
Server string: IPv4, IPv6 or DNS address of the SSL-VPN server.
SourceIp string: IPv4 or IPv6 address to use as a source for the SSL-VPN connection to the server.
Status string: Enable/disable this SSL-VPN client configuration. Valid values: enable, disable.
User string: Username to offer to the peer to authenticate the client.
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.

Certificate string: Certificate to offer to SSL-VPN server if it requests one.
ClassId int: Traffic class ID.
Comment string: Comment.
Distance int: Distance for routes added by SSL-VPN (1 - 255).
Interface string: SSL interface to send/receive traffic over.
Ipv4Subnets string: IPv4 subnets that the client is protecting.
Ipv6Subnets string: IPv6 subnets that the client is protecting.
Name string: SSL-VPN tunnel name.
Peer string: Authenticate peer's certificate with the peer/peergrp.
Port int: SSL-VPN server port.
Priority int: Priority for routes added by SSL-VPN. On FortiOS versions 7.0.1-7.0.3: 0 - 4294967295. On FortiOS versions >= 7.0.4: 1 - 65535.
Psk string: Pre-shared secret to authenticate with the server (ASCII string or hexadecimal encoded with a leading 0x).
Realm string: Realm name configured on SSL-VPN server.
Server string: IPv4, IPv6 or DNS address of the SSL-VPN server.
SourceIp string: IPv4 or IPv6 address to use as a source for the SSL-VPN connection to the server.
Status string: Enable/disable this SSL-VPN client configuration. Valid values: enable, disable.
User string: Username to offer to the peer to authenticate the client.
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.

certificate String: Certificate to offer to SSL-VPN server if it requests one.
classId Integer: Traffic class ID.
comment String: Comment.
distance Integer: Distance for routes added by SSL-VPN (1 - 255).
interface_ String: SSL interface to send/receive traffic over.
ipv4Subnets String: IPv4 subnets that the client is protecting.
ipv6Subnets String: IPv6 subnets that the client is protecting.
name String: SSL-VPN tunnel name.
peer String: Authenticate peer's certificate with the peer/peergrp.
port Integer: SSL-VPN server port.
priority Integer: Priority for routes added by SSL-VPN. On FortiOS versions 7.0.1-7.0.3: 0 - 4294967295. On FortiOS versions >= 7.0.4: 1 - 65535.
psk String: Pre-shared secret to authenticate with the server (ASCII string or hexadecimal encoded with a leading 0x).
realm String: Realm name configured on SSL-VPN server.
server String: IPv4, IPv6 or DNS address of the SSL-VPN server.
sourceIp String: IPv4 or IPv6 address to use as a source for the SSL-VPN connection to the server.
status String: Enable/disable this SSL-VPN client configuration. Valid values: enable, disable.
user String: Username to offer to the peer to authenticate the client.
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.

certificate string: Certificate to offer to SSL-VPN server if it requests one.
classId number: Traffic class ID.
comment string: Comment.
distance number: Distance for routes added by SSL-VPN (1 - 255).
interface string: SSL interface to send/receive traffic over.
ipv4Subnets string: IPv4 subnets that the client is protecting.
ipv6Subnets string: IPv6 subnets that the client is protecting.
name string: SSL-VPN tunnel name.
peer string: Authenticate peer's certificate with the peer/peergrp.
port number: SSL-VPN server port.
priority number: Priority for routes added by SSL-VPN. On FortiOS versions 7.0.1-7.0.3: 0 - 4294967295. On FortiOS versions >= 7.0.4: 1 - 65535.
psk string: Pre-shared secret to authenticate with the server (ASCII string or hexadecimal encoded with a leading 0x).
realm string: Realm name configured on SSL-VPN server.
server string: IPv4, IPv6 or DNS address of the SSL-VPN server.
sourceIp string: IPv4 or IPv6 address to use as a source for the SSL-VPN connection to the server.
status string: Enable/disable this SSL-VPN client configuration. Valid values: enable, disable.
user string: Username to offer to the peer to authenticate the client.
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.

certificate str: Certificate to offer to SSL-VPN server if it requests one.
class_id int: Traffic class ID.
comment str: Comment.
distance int: Distance for routes added by SSL-VPN (1 - 255).
interface str: SSL interface to send/receive traffic over.
ipv4_subnets str: IPv4 subnets that the client is protecting.
ipv6_subnets str: IPv6 subnets that the client is protecting.
name str: SSL-VPN tunnel name.
peer str: Authenticate peer's certificate with the peer/peergrp.
port int: SSL-VPN server port.
priority int: Priority for routes added by SSL-VPN. On FortiOS versions 7.0.1-7.0.3: 0 - 4294967295. On FortiOS versions >= 7.0.4: 1 - 65535.
psk str: Pre-shared secret to authenticate with the server (ASCII string or hexadecimal encoded with a leading 0x).
realm str: Realm name configured on SSL-VPN server.
server str: IPv4, IPv6 or DNS address of the SSL-VPN server.
source_ip str: IPv4 or IPv6 address to use as a source for the SSL-VPN connection to the server.
status str: Enable/disable this SSL-VPN client configuration. Valid values: enable, disable.
user str: Username to offer to the peer to authenticate the client.
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.

certificate String: Certificate to offer to SSL-VPN server if it requests one.
classId Number: Traffic class ID.
comment String: Comment.
distance Number: Distance for routes added by SSL-VPN (1 - 255).
interface String: SSL interface to send/receive traffic over.
ipv4Subnets String: IPv4 subnets that the client is protecting.
ipv6Subnets String: IPv6 subnets that the client is protecting.
name String: SSL-VPN tunnel name.
peer String: Authenticate peer's certificate with the peer/peergrp.
port Number: SSL-VPN server port.
priority Number: Priority for routes added by SSL-VPN. On FortiOS versions 7.0.1-7.0.3: 0 - 4294967295. On FortiOS versions >= 7.0.4: 1 - 65535.
psk String: Pre-shared secret to authenticate with the server (ASCII string or hexadecimal encoded with a leading 0x).
realm String: Realm name configured on SSL-VPN server.
server String: IPv4, IPv6 or DNS address of the SSL-VPN server.
sourceIp String: IPv4 or IPv6 address to use as a source for the SSL-VPN connection to the server.
status String: Enable/disable this SSL-VPN client configuration. Valid values: enable, disable.
user String: Username to offer to the peer to authenticate the client.
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

VpnSsl Client can be imported using any of these accepted formats:

$ pulumi import fortios:vpn/ssl/client:Client labelname {{name}}

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:vpn/ssl/client:Client 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 v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

pulumiverse/pulumi-fortios

fortios.vpn/ssl.Client

On this page

On this page

Create Client Resource

Constructor syntax

Parameters

Client Resource Properties

Inputs

Outputs

Look up Existing Client Resource

Import

Package Details

On this page

On this page