1. Packages
  2. Fortios
  3. API Docs
  4. firewall
  5. firewall/ssh
  6. Localkey
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.firewall/ssh.Localkey

Explore with Pulumi AI

SSH proxy local keys.

Create Localkey Resource

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

Constructor syntax

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

@overload
def Localkey(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             private_key: Optional[str] = None,
             public_key: Optional[str] = None,
             name: Optional[str] = None,
             password: Optional[str] = None,
             source: Optional[str] = None,
             vdomparam: Optional[str] = None)
func NewLocalkey(ctx *Context, name string, args LocalkeyArgs, opts ...ResourceOption) (*Localkey, error)
public Localkey(string name, LocalkeyArgs args, CustomResourceOptions? opts = null)
public Localkey(String name, LocalkeyArgs args)
public Localkey(String name, LocalkeyArgs args, CustomResourceOptions options)
type: fortios:firewall/ssh/localkey:Localkey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

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

PrivateKey This property is required. string
SSH proxy private key, encrypted with a password.
PublicKey This property is required. string
SSH proxy public key.
Name string
SSH proxy local key name.
Password string
Password for SSH private key.
Source string
SSH proxy local key source type. Valid values: built-in, user.
Vdomparam Changes to this property will trigger replacement. 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.
PrivateKey This property is required. string
SSH proxy private key, encrypted with a password.
PublicKey This property is required. string
SSH proxy public key.
Name string
SSH proxy local key name.
Password string
Password for SSH private key.
Source string
SSH proxy local key source type. Valid values: built-in, user.
Vdomparam Changes to this property will trigger replacement. 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.
privateKey This property is required. String
SSH proxy private key, encrypted with a password.
publicKey This property is required. String
SSH proxy public key.
name String
SSH proxy local key name.
password String
Password for SSH private key.
source String
SSH proxy local key source type. Valid values: built-in, user.
vdomparam Changes to this property will trigger replacement. 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.
privateKey This property is required. string
SSH proxy private key, encrypted with a password.
publicKey This property is required. string
SSH proxy public key.
name string
SSH proxy local key name.
password string
Password for SSH private key.
source string
SSH proxy local key source type. Valid values: built-in, user.
vdomparam Changes to this property will trigger replacement. 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.
private_key This property is required. str
SSH proxy private key, encrypted with a password.
public_key This property is required. str
SSH proxy public key.
name str
SSH proxy local key name.
password str
Password for SSH private key.
source str
SSH proxy local key source type. Valid values: built-in, user.
vdomparam Changes to this property will trigger replacement. 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.
privateKey This property is required. String
SSH proxy private key, encrypted with a password.
publicKey This property is required. String
SSH proxy public key.
name String
SSH proxy local key name.
password String
Password for SSH private key.
source String
SSH proxy local key source type. Valid values: built-in, user.
vdomparam Changes to this property will trigger replacement. 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 Localkey 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 Localkey Resource

Get an existing Localkey 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?: LocalkeyState, opts?: CustomResourceOptions): Localkey
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        private_key: Optional[str] = None,
        public_key: Optional[str] = None,
        source: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Localkey
func GetLocalkey(ctx *Context, name string, id IDInput, state *LocalkeyState, opts ...ResourceOption) (*Localkey, error)
public static Localkey Get(string name, Input<string> id, LocalkeyState? state, CustomResourceOptions? opts = null)
public static Localkey get(String name, Output<String> id, LocalkeyState state, CustomResourceOptions options)
resources:  _:    type: fortios:firewall/ssh/localkey:Localkey    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Name string
SSH proxy local key name.
Password string
Password for SSH private key.
PrivateKey string
SSH proxy private key, encrypted with a password.
PublicKey string
SSH proxy public key.
Source string
SSH proxy local key source type. Valid values: built-in, user.
Vdomparam Changes to this property will trigger replacement. 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.
Name string
SSH proxy local key name.
Password string
Password for SSH private key.
PrivateKey string
SSH proxy private key, encrypted with a password.
PublicKey string
SSH proxy public key.
Source string
SSH proxy local key source type. Valid values: built-in, user.
Vdomparam Changes to this property will trigger replacement. 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.
name String
SSH proxy local key name.
password String
Password for SSH private key.
privateKey String
SSH proxy private key, encrypted with a password.
publicKey String
SSH proxy public key.
source String
SSH proxy local key source type. Valid values: built-in, user.
vdomparam Changes to this property will trigger replacement. 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.
name string
SSH proxy local key name.
password string
Password for SSH private key.
privateKey string
SSH proxy private key, encrypted with a password.
publicKey string
SSH proxy public key.
source string
SSH proxy local key source type. Valid values: built-in, user.
vdomparam Changes to this property will trigger replacement. 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.
name str
SSH proxy local key name.
password str
Password for SSH private key.
private_key str
SSH proxy private key, encrypted with a password.
public_key str
SSH proxy public key.
source str
SSH proxy local key source type. Valid values: built-in, user.
vdomparam Changes to this property will trigger replacement. 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.
name String
SSH proxy local key name.
password String
Password for SSH private key.
privateKey String
SSH proxy private key, encrypted with a password.
publicKey String
SSH proxy public key.
source String
SSH proxy local key source type. Valid values: built-in, user.
vdomparam Changes to this property will trigger replacement. 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

FirewallSsh LocalKey can be imported using any of these accepted formats:

$ pulumi import fortios:firewall/ssh/localkey:Localkey labelname {{name}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:firewall/ssh/localkey:Localkey labelname {{name}}
Copy

$ 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.