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

fortios.firewall/ssh.Localkey

Explore with Pulumi AI

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

    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 string
    The unique name of the resource.
    args LocalkeyArgs
    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 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 string
    The unique name of the resource.
    args LocalkeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LocalkeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LocalkeyArgs
    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 localkeyResource = new Fortios.Firewall.Ssh.Localkey("localkeyResource", new()
    {
        PrivateKey = "string",
        PublicKey = "string",
        Name = "string",
        Password = "string",
        Source = "string",
        Vdomparam = "string",
    });
    
    example, err := firewall.NewLocalkey(ctx, "localkeyResource", &firewall.LocalkeyArgs{
    	PrivateKey: pulumi.String("string"),
    	PublicKey:  pulumi.String("string"),
    	Name:       pulumi.String("string"),
    	Password:   pulumi.String("string"),
    	Source:     pulumi.String("string"),
    	Vdomparam:  pulumi.String("string"),
    })
    
    var localkeyResource = new Localkey("localkeyResource", LocalkeyArgs.builder()
        .privateKey("string")
        .publicKey("string")
        .name("string")
        .password("string")
        .source("string")
        .vdomparam("string")
        .build());
    
    localkey_resource = fortios.firewall.ssh.Localkey("localkeyResource",
        private_key="string",
        public_key="string",
        name="string",
        password="string",
        source="string",
        vdomparam="string")
    
    const localkeyResource = new fortios.firewall.ssh.Localkey("localkeyResource", {
        privateKey: "string",
        publicKey: "string",
        name: "string",
        password: "string",
        source: "string",
        vdomparam: "string",
    });
    
    Coming soon!
    

    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

    The Localkey resource accepts the following input properties:

    PrivateKey string
    SSH proxy private key, encrypted with a password.
    PublicKey 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 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 string
    SSH proxy private key, encrypted with a password.
    PublicKey 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 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 String
    SSH proxy private key, encrypted with a password.
    publicKey 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 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 string
    SSH proxy private key, encrypted with a password.
    publicKey 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 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 str
    SSH proxy private key, encrypted with a password.
    public_key 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 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 String
    SSH proxy private key, encrypted with a password.
    publicKey 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 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)
    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:
    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 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 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 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 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 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 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}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:firewall/ssh/localkey:Localkey 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