Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortios
  3. API Docs
  4. nsxt
  5. Servicechain
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.nsxt.Servicechain

Explore with Pulumi AI

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

    Configure NSX-T service chain. Applies to FortiOS Version >= 6.4.10.

    Create Servicechain Resource

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

    Constructor syntax

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

@overload
def Servicechain(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 dynamic_sort_subtable: Optional[str] = None,
                 fosid: Optional[int] = None,
                 get_all_tables: Optional[str] = None,
                 name: Optional[str] = None,
                 service_indices: Optional[Sequence[ServicechainServiceIndexArgs]] = None,
                 vdomparam: Optional[str] = None)
    func NewServicechain(ctx *Context, name string, args *ServicechainArgs, opts ...ResourceOption) (*Servicechain, error)
    public Servicechain(string name, ServicechainArgs? args = null, CustomResourceOptions? opts = null)
    public Servicechain(String name, ServicechainArgs args)
public Servicechain(String name, ServicechainArgs args, CustomResourceOptions options)

    type: fortios:nsxt:Servicechain
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 ServicechainArgs
    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 ServicechainArgs
    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 ServicechainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServicechainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServicechainArgs
    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 servicechainResource = new Fortios.Nsxt.Servicechain("servicechainResource", new()
{
    DynamicSortSubtable = "string",
    Fosid = 0,
    GetAllTables = "string",
    Name = "string",
    ServiceIndices = new[]
    {
        new Fortios.Nsxt.Inputs.ServicechainServiceIndexArgs
        {
            Id = 0,
            Name = "string",
            ReverseIndex = 0,
            Vd = "string",
        },
    },
    Vdomparam = "string",
});

    example, err := nsxt.NewServicechain(ctx, "servicechainResource", &nsxt.ServicechainArgs{
	DynamicSortSubtable: pulumi.String("string"),
	Fosid:               pulumi.Int(0),
	GetAllTables:        pulumi.String("string"),
	Name:                pulumi.String("string"),
	ServiceIndices: nsxt.ServicechainServiceIndexArray{
		&nsxt.ServicechainServiceIndexArgs{
			Id:           pulumi.Int(0),
			Name:         pulumi.String("string"),
			ReverseIndex: pulumi.Int(0),
			Vd:           pulumi.String("string"),
		},
	},
	Vdomparam: pulumi.String("string"),
})

    var servicechainResource = new Servicechain("servicechainResource", ServicechainArgs.builder()
    .dynamicSortSubtable("string")
    .fosid(0)
    .getAllTables("string")
    .name("string")
    .serviceIndices(ServicechainServiceIndexArgs.builder()
        .id(0)
        .name("string")
        .reverseIndex(0)
        .vd("string")
        .build())
    .vdomparam("string")
    .build());

    servicechain_resource = fortios.nsxt.Servicechain("servicechainResource",
    dynamic_sort_subtable="string",
    fosid=0,
    get_all_tables="string",
    name="string",
    service_indices=[{
        "id": 0,
        "name": "string",
        "reverse_index": 0,
        "vd": "string",
    }],
    vdomparam="string")

    const servicechainResource = new fortios.nsxt.Servicechain("servicechainResource", {
    dynamicSortSubtable: "string",
    fosid: 0,
    getAllTables: "string",
    name: "string",
    serviceIndices: [{
        id: 0,
        name: "string",
        reverseIndex: 0,
        vd: "string",
    }],
    vdomparam: "string",
});

    type: fortios:nsxt:Servicechain
properties:
    dynamicSortSubtable: string
    fosid: 0
    getAllTables: string
    name: string
    serviceIndices:
        - id: 0
          name: string
          reverseIndex: 0
          vd: string
    vdomparam: string

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

    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    Fosid int
    Chain ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Chain name.
    ServiceIndices List<Pulumiverse.Fortios.Nsxt.Inputs.ServicechainServiceIndex>
    Configure service index. The structure of service_index block is documented below.
    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.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    Fosid int
    Chain ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Chain name.
    ServiceIndices []ServicechainServiceIndexArgs
    Configure service index. The structure of service_index block is documented below.
    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.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    fosid Integer
    Chain ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Chain name.
    serviceIndices List<ServicechainServiceIndex>
    Configure service index. The structure of service_index block is documented below.
    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.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    fosid number
    Chain ID.
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name string
    Chain name.
    serviceIndices ServicechainServiceIndex[]
    Configure service index. The structure of service_index block is documented below.
    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.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    fosid int
    Chain ID.
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name str
    Chain name.
    service_indices Sequence[ServicechainServiceIndexArgs]
    Configure service index. The structure of service_index block is documented below.
    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.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    fosid Number
    Chain ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Chain name.
    serviceIndices List<Property Map>
    Configure service index. The structure of service_index block is documented below.
    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 Servicechain 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 Servicechain Resource

    Get an existing Servicechain 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?: ServicechainState, opts?: CustomResourceOptions): Servicechain
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dynamic_sort_subtable: Optional[str] = None,
        fosid: Optional[int] = None,
        get_all_tables: Optional[str] = None,
        name: Optional[str] = None,
        service_indices: Optional[Sequence[ServicechainServiceIndexArgs]] = None,
        vdomparam: Optional[str] = None) -> Servicechain
    func GetServicechain(ctx *Context, name string, id IDInput, state *ServicechainState, opts ...ResourceOption) (*Servicechain, error)
    public static Servicechain Get(string name, Input<string> id, ServicechainState? state, CustomResourceOptions? opts = null)
    public static Servicechain get(String name, Output<String> id, ServicechainState 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:
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    Fosid int
    Chain ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Chain name.
    ServiceIndices List<Pulumiverse.Fortios.Nsxt.Inputs.ServicechainServiceIndex>
    Configure service index. The structure of service_index block is documented below.
    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.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    Fosid int
    Chain ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Chain name.
    ServiceIndices []ServicechainServiceIndexArgs
    Configure service index. The structure of service_index block is documented below.
    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.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    fosid Integer
    Chain ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Chain name.
    serviceIndices List<ServicechainServiceIndex>
    Configure service index. The structure of service_index block is documented below.
    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.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    fosid number
    Chain ID.
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name string
    Chain name.
    serviceIndices ServicechainServiceIndex[]
    Configure service index. The structure of service_index block is documented below.
    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.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    fosid int
    Chain ID.
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name str
    Chain name.
    service_indices Sequence[ServicechainServiceIndexArgs]
    Configure service index. The structure of service_index block is documented below.
    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.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    fosid Number
    Chain ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Chain name.
    serviceIndices List<Property Map>
    Configure service index. The structure of service_index block is documented below.
    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.

    Supporting Types

    ServicechainServiceIndex, ServicechainServiceIndexArgs

    Id int
    Service index.
    Name string
    Index name.
    ReverseIndex int
    Reverse service index.
    Vd string
    VDOM name.
    Id int
    Service index.
    Name string
    Index name.
    ReverseIndex int
    Reverse service index.
    Vd string
    VDOM name.
    id Integer
    Service index.
    name String
    Index name.
    reverseIndex Integer
    Reverse service index.
    vd String
    VDOM name.
    id number
    Service index.
    name string
    Index name.
    reverseIndex number
    Reverse service index.
    vd string
    VDOM name.
    id int
    Service index.
    name str
    Index name.
    reverse_index int
    Reverse service index.
    vd str
    VDOM name.
    id Number
    Service index.
    name String
    Index name.
    reverseIndex Number
    Reverse service index.
    vd String
    VDOM name.

    Import

    Nsxt ServiceChain can be imported using any of these accepted formats:

    $ pulumi import fortios:nsxt/servicechain:Servicechain labelname {{fosid}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:nsxt/servicechain:Servicechain 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.6 published on Tuesday, Jul 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios