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

fortios.user.Fortitoken

Explore with Pulumi AI

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

    Configure FortiToken.

    Create Fortitoken Resource

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

    Constructor syntax

    new Fortitoken(name: string, args?: FortitokenArgs, opts?: CustomResourceOptions);
    @overload
    def Fortitoken(resource_name: str,
                   args: Optional[FortitokenArgs] = None,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Fortitoken(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   activation_code: Optional[str] = None,
                   activation_expire: Optional[int] = None,
                   comments: Optional[str] = None,
                   license: Optional[str] = None,
                   os_ver: Optional[str] = None,
                   reg_id: Optional[str] = None,
                   seed: Optional[str] = None,
                   serial_number: Optional[str] = None,
                   status: Optional[str] = None,
                   vdomparam: Optional[str] = None)
    func NewFortitoken(ctx *Context, name string, args *FortitokenArgs, opts ...ResourceOption) (*Fortitoken, error)
    public Fortitoken(string name, FortitokenArgs? args = null, CustomResourceOptions? opts = null)
    public Fortitoken(String name, FortitokenArgs args)
    public Fortitoken(String name, FortitokenArgs args, CustomResourceOptions options)
    
    type: fortios:user:Fortitoken
    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 FortitokenArgs
    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 FortitokenArgs
    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 FortitokenArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FortitokenArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FortitokenArgs
    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 fortitokenResource = new Fortios.User.Fortitoken("fortitokenResource", new()
    {
        ActivationCode = "string",
        ActivationExpire = 0,
        Comments = "string",
        License = "string",
        OsVer = "string",
        RegId = "string",
        Seed = "string",
        SerialNumber = "string",
        Status = "string",
        Vdomparam = "string",
    });
    
    example, err := user.NewFortitoken(ctx, "fortitokenResource", &user.FortitokenArgs{
    	ActivationCode:   pulumi.String("string"),
    	ActivationExpire: pulumi.Int(0),
    	Comments:         pulumi.String("string"),
    	License:          pulumi.String("string"),
    	OsVer:            pulumi.String("string"),
    	RegId:            pulumi.String("string"),
    	Seed:             pulumi.String("string"),
    	SerialNumber:     pulumi.String("string"),
    	Status:           pulumi.String("string"),
    	Vdomparam:        pulumi.String("string"),
    })
    
    var fortitokenResource = new Fortitoken("fortitokenResource", FortitokenArgs.builder()        
        .activationCode("string")
        .activationExpire(0)
        .comments("string")
        .license("string")
        .osVer("string")
        .regId("string")
        .seed("string")
        .serialNumber("string")
        .status("string")
        .vdomparam("string")
        .build());
    
    fortitoken_resource = fortios.user.Fortitoken("fortitokenResource",
        activation_code="string",
        activation_expire=0,
        comments="string",
        license="string",
        os_ver="string",
        reg_id="string",
        seed="string",
        serial_number="string",
        status="string",
        vdomparam="string")
    
    const fortitokenResource = new fortios.user.Fortitoken("fortitokenResource", {
        activationCode: "string",
        activationExpire: 0,
        comments: "string",
        license: "string",
        osVer: "string",
        regId: "string",
        seed: "string",
        serialNumber: "string",
        status: "string",
        vdomparam: "string",
    });
    
    type: fortios:user:Fortitoken
    properties:
        activationCode: string
        activationExpire: 0
        comments: string
        license: string
        osVer: string
        regId: string
        seed: string
        serialNumber: string
        status: string
        vdomparam: string
    

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

    ActivationCode string
    Mobile token user activation-code.
    ActivationExpire int
    Mobile token user activation-code expire time.
    Comments string
    Comment.
    License string
    Mobile token license.
    OsVer string
    Device Mobile Version.
    RegId string
    Device Reg ID.
    Seed string
    Token seed.
    SerialNumber string
    Serial number.
    Status string
    Status Valid values: active, lock.
    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.
    ActivationCode string
    Mobile token user activation-code.
    ActivationExpire int
    Mobile token user activation-code expire time.
    Comments string
    Comment.
    License string
    Mobile token license.
    OsVer string
    Device Mobile Version.
    RegId string
    Device Reg ID.
    Seed string
    Token seed.
    SerialNumber string
    Serial number.
    Status string
    Status Valid values: active, lock.
    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.
    activationCode String
    Mobile token user activation-code.
    activationExpire Integer
    Mobile token user activation-code expire time.
    comments String
    Comment.
    license String
    Mobile token license.
    osVer String
    Device Mobile Version.
    regId String
    Device Reg ID.
    seed String
    Token seed.
    serialNumber String
    Serial number.
    status String
    Status Valid values: active, lock.
    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.
    activationCode string
    Mobile token user activation-code.
    activationExpire number
    Mobile token user activation-code expire time.
    comments string
    Comment.
    license string
    Mobile token license.
    osVer string
    Device Mobile Version.
    regId string
    Device Reg ID.
    seed string
    Token seed.
    serialNumber string
    Serial number.
    status string
    Status Valid values: active, lock.
    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.
    activation_code str
    Mobile token user activation-code.
    activation_expire int
    Mobile token user activation-code expire time.
    comments str
    Comment.
    license str
    Mobile token license.
    os_ver str
    Device Mobile Version.
    reg_id str
    Device Reg ID.
    seed str
    Token seed.
    serial_number str
    Serial number.
    status str
    Status Valid values: active, lock.
    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.
    activationCode String
    Mobile token user activation-code.
    activationExpire Number
    Mobile token user activation-code expire time.
    comments String
    Comment.
    license String
    Mobile token license.
    osVer String
    Device Mobile Version.
    regId String
    Device Reg ID.
    seed String
    Token seed.
    serialNumber String
    Serial number.
    status String
    Status Valid values: active, lock.
    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 Fortitoken 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 Fortitoken Resource

    Get an existing Fortitoken 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?: FortitokenState, opts?: CustomResourceOptions): Fortitoken
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            activation_code: Optional[str] = None,
            activation_expire: Optional[int] = None,
            comments: Optional[str] = None,
            license: Optional[str] = None,
            os_ver: Optional[str] = None,
            reg_id: Optional[str] = None,
            seed: Optional[str] = None,
            serial_number: Optional[str] = None,
            status: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Fortitoken
    func GetFortitoken(ctx *Context, name string, id IDInput, state *FortitokenState, opts ...ResourceOption) (*Fortitoken, error)
    public static Fortitoken Get(string name, Input<string> id, FortitokenState? state, CustomResourceOptions? opts = null)
    public static Fortitoken get(String name, Output<String> id, FortitokenState 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:
    ActivationCode string
    Mobile token user activation-code.
    ActivationExpire int
    Mobile token user activation-code expire time.
    Comments string
    Comment.
    License string
    Mobile token license.
    OsVer string
    Device Mobile Version.
    RegId string
    Device Reg ID.
    Seed string
    Token seed.
    SerialNumber string
    Serial number.
    Status string
    Status Valid values: active, lock.
    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.
    ActivationCode string
    Mobile token user activation-code.
    ActivationExpire int
    Mobile token user activation-code expire time.
    Comments string
    Comment.
    License string
    Mobile token license.
    OsVer string
    Device Mobile Version.
    RegId string
    Device Reg ID.
    Seed string
    Token seed.
    SerialNumber string
    Serial number.
    Status string
    Status Valid values: active, lock.
    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.
    activationCode String
    Mobile token user activation-code.
    activationExpire Integer
    Mobile token user activation-code expire time.
    comments String
    Comment.
    license String
    Mobile token license.
    osVer String
    Device Mobile Version.
    regId String
    Device Reg ID.
    seed String
    Token seed.
    serialNumber String
    Serial number.
    status String
    Status Valid values: active, lock.
    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.
    activationCode string
    Mobile token user activation-code.
    activationExpire number
    Mobile token user activation-code expire time.
    comments string
    Comment.
    license string
    Mobile token license.
    osVer string
    Device Mobile Version.
    regId string
    Device Reg ID.
    seed string
    Token seed.
    serialNumber string
    Serial number.
    status string
    Status Valid values: active, lock.
    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.
    activation_code str
    Mobile token user activation-code.
    activation_expire int
    Mobile token user activation-code expire time.
    comments str
    Comment.
    license str
    Mobile token license.
    os_ver str
    Device Mobile Version.
    reg_id str
    Device Reg ID.
    seed str
    Token seed.
    serial_number str
    Serial number.
    status str
    Status Valid values: active, lock.
    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.
    activationCode String
    Mobile token user activation-code.
    activationExpire Number
    Mobile token user activation-code expire time.
    comments String
    Comment.
    license String
    Mobile token license.
    osVer String
    Device Mobile Version.
    regId String
    Device Reg ID.
    seed String
    Token seed.
    serialNumber String
    Serial number.
    status String
    Status Valid values: active, lock.
    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

    User Fortitoken can be imported using any of these accepted formats:

    $ pulumi import fortios:user/fortitoken:Fortitoken labelname {{serial_number}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:user/fortitoken:Fortitoken labelname {{serial_number}}
    

    $ 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