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

fortios.icap.Servergroup

Explore with Pulumi AI

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

    Configure an ICAP server group consisting of multiple forward servers. Supports failover and load balancing. Applies to FortiOS Version >= 7.2.0.

    Create Servergroup Resource

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

    Constructor syntax

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

@overload
def Servergroup(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                dynamic_sort_subtable: Optional[str] = None,
                get_all_tables: Optional[str] = None,
                ldb_method: Optional[str] = None,
                name: Optional[str] = None,
                server_lists: Optional[Sequence[ServergroupServerListArgs]] = None,
                vdomparam: Optional[str] = None)
    func NewServergroup(ctx *Context, name string, args *ServergroupArgs, opts ...ResourceOption) (*Servergroup, error)
    public Servergroup(string name, ServergroupArgs? args = null, CustomResourceOptions? opts = null)
    public Servergroup(String name, ServergroupArgs args)
public Servergroup(String name, ServergroupArgs args, CustomResourceOptions options)

    type: fortios:icap:Servergroup
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 ServergroupArgs
    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 ServergroupArgs
    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 ServergroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServergroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServergroupArgs
    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 servergroupResource = new Fortios.Icap.Servergroup("servergroupResource", new()
{
    DynamicSortSubtable = "string",
    GetAllTables = "string",
    LdbMethod = "string",
    Name = "string",
    ServerLists = new[]
    {
        new Fortios.Icap.Inputs.ServergroupServerListArgs
        {
            Name = "string",
            Weight = 0,
        },
    },
    Vdomparam = "string",
});

    example, err := icap.NewServergroup(ctx, "servergroupResource", &icap.ServergroupArgs{
	DynamicSortSubtable: pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	LdbMethod:           pulumi.String("string"),
	Name:                pulumi.String("string"),
	ServerLists: icap.ServergroupServerListArray{
		&icap.ServergroupServerListArgs{
			Name:   pulumi.String("string"),
			Weight: pulumi.Int(0),
		},
	},
	Vdomparam: pulumi.String("string"),
})

    var servergroupResource = new Servergroup("servergroupResource", ServergroupArgs.builder()
    .dynamicSortSubtable("string")
    .getAllTables("string")
    .ldbMethod("string")
    .name("string")
    .serverLists(ServergroupServerListArgs.builder()
        .name("string")
        .weight(0)
        .build())
    .vdomparam("string")
    .build());

    servergroup_resource = fortios.icap.Servergroup("servergroupResource",
    dynamic_sort_subtable="string",
    get_all_tables="string",
    ldb_method="string",
    name="string",
    server_lists=[{
        "name": "string",
        "weight": 0,
    }],
    vdomparam="string")

    const servergroupResource = new fortios.icap.Servergroup("servergroupResource", {
    dynamicSortSubtable: "string",
    getAllTables: "string",
    ldbMethod: "string",
    name: "string",
    serverLists: [{
        name: "string",
        weight: 0,
    }],
    vdomparam: "string",
});

    type: fortios:icap:Servergroup
properties:
    dynamicSortSubtable: string
    getAllTables: string
    ldbMethod: string
    name: string
    serverLists:
        - name: string
          weight: 0
    vdomparam: string

    Servergroup 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 Servergroup 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 ].
    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.
    LdbMethod string
    Load balance method. Valid values: weighted, least-session, active-passive.
    Name string
    Configure an ICAP server group consisting one or multiple forward servers. Supports failover and load balancing.
    ServerLists List<Pulumiverse.Fortios.Icap.Inputs.ServergroupServerList>
    Add ICAP servers to a list to form a server group. Optionally assign weights to each server. The structure of server_list 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 ].
    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.
    LdbMethod string
    Load balance method. Valid values: weighted, least-session, active-passive.
    Name string
    Configure an ICAP server group consisting one or multiple forward servers. Supports failover and load balancing.
    ServerLists []ServergroupServerListArgs
    Add ICAP servers to a list to form a server group. Optionally assign weights to each server. The structure of server_list 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 ].
    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.
    ldbMethod String
    Load balance method. Valid values: weighted, least-session, active-passive.
    name String
    Configure an ICAP server group consisting one or multiple forward servers. Supports failover and load balancing.
    serverLists List<ServergroupServerList>
    Add ICAP servers to a list to form a server group. Optionally assign weights to each server. The structure of server_list 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 ].
    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.
    ldbMethod string
    Load balance method. Valid values: weighted, least-session, active-passive.
    name string
    Configure an ICAP server group consisting one or multiple forward servers. Supports failover and load balancing.
    serverLists ServergroupServerList[]
    Add ICAP servers to a list to form a server group. Optionally assign weights to each server. The structure of server_list 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 ].
    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.
    ldb_method str
    Load balance method. Valid values: weighted, least-session, active-passive.
    name str
    Configure an ICAP server group consisting one or multiple forward servers. Supports failover and load balancing.
    server_lists Sequence[ServergroupServerListArgs]
    Add ICAP servers to a list to form a server group. Optionally assign weights to each server. The structure of server_list 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 ].
    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.
    ldbMethod String
    Load balance method. Valid values: weighted, least-session, active-passive.
    name String
    Configure an ICAP server group consisting one or multiple forward servers. Supports failover and load balancing.
    serverLists List<Property Map>
    Add ICAP servers to a list to form a server group. Optionally assign weights to each server. The structure of server_list 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 Servergroup 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 Servergroup Resource

    Get an existing Servergroup 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?: ServergroupState, opts?: CustomResourceOptions): Servergroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        ldb_method: Optional[str] = None,
        name: Optional[str] = None,
        server_lists: Optional[Sequence[ServergroupServerListArgs]] = None,
        vdomparam: Optional[str] = None) -> Servergroup
    func GetServergroup(ctx *Context, name string, id IDInput, state *ServergroupState, opts ...ResourceOption) (*Servergroup, error)
    public static Servergroup Get(string name, Input<string> id, ServergroupState? state, CustomResourceOptions? opts = null)
    public static Servergroup get(String name, Output<String> id, ServergroupState 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 ].
    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.
    LdbMethod string
    Load balance method. Valid values: weighted, least-session, active-passive.
    Name string
    Configure an ICAP server group consisting one or multiple forward servers. Supports failover and load balancing.
    ServerLists List<Pulumiverse.Fortios.Icap.Inputs.ServergroupServerList>
    Add ICAP servers to a list to form a server group. Optionally assign weights to each server. The structure of server_list 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 ].
    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.
    LdbMethod string
    Load balance method. Valid values: weighted, least-session, active-passive.
    Name string
    Configure an ICAP server group consisting one or multiple forward servers. Supports failover and load balancing.
    ServerLists []ServergroupServerListArgs
    Add ICAP servers to a list to form a server group. Optionally assign weights to each server. The structure of server_list 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 ].
    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.
    ldbMethod String
    Load balance method. Valid values: weighted, least-session, active-passive.
    name String
    Configure an ICAP server group consisting one or multiple forward servers. Supports failover and load balancing.
    serverLists List<ServergroupServerList>
    Add ICAP servers to a list to form a server group. Optionally assign weights to each server. The structure of server_list 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 ].
    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.
    ldbMethod string
    Load balance method. Valid values: weighted, least-session, active-passive.
    name string
    Configure an ICAP server group consisting one or multiple forward servers. Supports failover and load balancing.
    serverLists ServergroupServerList[]
    Add ICAP servers to a list to form a server group. Optionally assign weights to each server. The structure of server_list 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 ].
    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.
    ldb_method str
    Load balance method. Valid values: weighted, least-session, active-passive.
    name str
    Configure an ICAP server group consisting one or multiple forward servers. Supports failover and load balancing.
    server_lists Sequence[ServergroupServerListArgs]
    Add ICAP servers to a list to form a server group. Optionally assign weights to each server. The structure of server_list 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 ].
    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.
    ldbMethod String
    Load balance method. Valid values: weighted, least-session, active-passive.
    name String
    Configure an ICAP server group consisting one or multiple forward servers. Supports failover and load balancing.
    serverLists List<Property Map>
    Add ICAP servers to a list to form a server group. Optionally assign weights to each server. The structure of server_list 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

    ServergroupServerList, ServergroupServerListArgs

    Name string
    ICAP server name.
    Weight int
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    Name string
    ICAP server name.
    Weight int
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    name String
    ICAP server name.
    weight Integer
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    name string
    ICAP server name.
    weight number
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    name str
    ICAP server name.
    weight int
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    name String
    ICAP server name.
    weight Number
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).

    Import

    Icap ServerGroup can be imported using any of these accepted formats:

    $ pulumi import fortios:icap/servergroup:Servergroup labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

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