1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectIcapServergroup
fortimanager 1.15.0 published on Thursday, Nov 13, 2025 by fortinetdev
Schema (JSON)
fortinetdev/terraform-provider-fortimanager

fortimanager.ObjectIcapServergroup

fortimanager logo
fortimanager 1.15.0 published on Thursday, Nov 13, 2025 by fortinetdev
Schema (JSON)
fortinetdev/terraform-provider-fortimanager

    Configure an ICAP server group consisting of multiple forward servers. Supports failover and load balancing.

    The following variables have sub resource. Avoid using them together, otherwise conflicts and overwrites may occur.

    • server_list: fortimanager.ObjectIcapServergroupServerlist

    Create ObjectIcapServergroup Resource

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

    Constructor syntax

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

@overload
def ObjectIcapServergroup(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          adom: Optional[str] = None,
                          dynamic_sort_subtable: Optional[str] = None,
                          ldb_method: Optional[str] = None,
                          name: Optional[str] = None,
                          object_icap_servergroup_id: Optional[str] = None,
                          scopetype: Optional[str] = None,
                          server_lists: Optional[Sequence[ObjectIcapServergroupServerListArgs]] = None)
    func NewObjectIcapServergroup(ctx *Context, name string, args *ObjectIcapServergroupArgs, opts ...ResourceOption) (*ObjectIcapServergroup, error)
    public ObjectIcapServergroup(string name, ObjectIcapServergroupArgs? args = null, CustomResourceOptions? opts = null)
    public ObjectIcapServergroup(String name, ObjectIcapServergroupArgs args)
public ObjectIcapServergroup(String name, ObjectIcapServergroupArgs args, CustomResourceOptions options)

    type: fortimanager:ObjectIcapServergroup
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 ObjectIcapServergroupArgs
    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 ObjectIcapServergroupArgs
    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 ObjectIcapServergroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectIcapServergroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectIcapServergroupArgs
    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 objectIcapServergroupResource = new Fortimanager.ObjectIcapServergroup("objectIcapServergroupResource", new()
{
    Adom = "string",
    DynamicSortSubtable = "string",
    LdbMethod = "string",
    Name = "string",
    ObjectIcapServergroupId = "string",
    Scopetype = "string",
    ServerLists = new[]
    {
        new Fortimanager.Inputs.ObjectIcapServergroupServerListArgs
        {
            Names = new[]
            {
                "string",
            },
            Weight = 0,
        },
    },
});

    example, err := fortimanager.NewObjectIcapServergroup(ctx, "objectIcapServergroupResource", &fortimanager.ObjectIcapServergroupArgs{
	Adom:                    pulumi.String("string"),
	DynamicSortSubtable:     pulumi.String("string"),
	LdbMethod:               pulumi.String("string"),
	Name:                    pulumi.String("string"),
	ObjectIcapServergroupId: pulumi.String("string"),
	Scopetype:               pulumi.String("string"),
	ServerLists: fortimanager.ObjectIcapServergroupServerListTypeArray{
		&fortimanager.ObjectIcapServergroupServerListTypeArgs{
			Names: pulumi.StringArray{
				pulumi.String("string"),
			},
			Weight: pulumi.Float64(0),
		},
	},
})

    var objectIcapServergroupResource = new ObjectIcapServergroup("objectIcapServergroupResource", ObjectIcapServergroupArgs.builder()
    .adom("string")
    .dynamicSortSubtable("string")
    .ldbMethod("string")
    .name("string")
    .objectIcapServergroupId("string")
    .scopetype("string")
    .serverLists(ObjectIcapServergroupServerListArgs.builder()
        .names("string")
        .weight(0.0)
        .build())
    .build());

    object_icap_servergroup_resource = fortimanager.ObjectIcapServergroup("objectIcapServergroupResource",
    adom="string",
    dynamic_sort_subtable="string",
    ldb_method="string",
    name="string",
    object_icap_servergroup_id="string",
    scopetype="string",
    server_lists=[{
        "names": ["string"],
        "weight": 0,
    }])

    const objectIcapServergroupResource = new fortimanager.ObjectIcapServergroup("objectIcapServergroupResource", {
    adom: "string",
    dynamicSortSubtable: "string",
    ldbMethod: "string",
    name: "string",
    objectIcapServergroupId: "string",
    scopetype: "string",
    serverLists: [{
        names: ["string"],
        weight: 0,
    }],
});

    type: fortimanager:ObjectIcapServergroup
properties:
    adom: string
    dynamicSortSubtable: string
    ldbMethod: string
    name: string
    objectIcapServergroupId: string
    scopetype: string
    serverLists:
        - names:
            - string
          weight: 0

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

    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-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.
    ObjectIcapServergroupId string
    an identifier for the resource with format {{name}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    ServerLists List<ObjectIcapServergroupServerList>
    Server-List. The structure of server_list block is documented below.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-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.
    ObjectIcapServergroupId string
    an identifier for the resource with format {{name}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    ServerLists []ObjectIcapServergroupServerListTypeArgs
    Server-List. The structure of server_list block is documented below.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-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.
    objectIcapServergroupId String
    an identifier for the resource with format {{name}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    serverLists List<ObjectIcapServergroupServerList>
    Server-List. The structure of server_list block is documented below.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    dynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-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.
    objectIcapServergroupId string
    an identifier for the resource with format {{name}}.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    serverLists ObjectIcapServergroupServerList[]
    Server-List. The structure of server_list block is documented below.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    dynamic_sort_subtable str
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-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.
    object_icap_servergroup_id str
    an identifier for the resource with format {{name}}.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    server_lists Sequence[ObjectIcapServergroupServerListArgs]
    Server-List. The structure of server_list block is documented below.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-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.
    objectIcapServergroupId String
    an identifier for the resource with format {{name}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    serverLists List<Property Map>
    Server-List. The structure of server_list block is documented below.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ObjectIcapServergroup 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 ObjectIcapServergroup Resource

    Get an existing ObjectIcapServergroup 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?: ObjectIcapServergroupState, opts?: CustomResourceOptions): ObjectIcapServergroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        ldb_method: Optional[str] = None,
        name: Optional[str] = None,
        object_icap_servergroup_id: Optional[str] = None,
        scopetype: Optional[str] = None,
        server_lists: Optional[Sequence[ObjectIcapServergroupServerListArgs]] = None) -> ObjectIcapServergroup
    func GetObjectIcapServergroup(ctx *Context, name string, id IDInput, state *ObjectIcapServergroupState, opts ...ResourceOption) (*ObjectIcapServergroup, error)
    public static ObjectIcapServergroup Get(string name, Input<string> id, ObjectIcapServergroupState? state, CustomResourceOptions? opts = null)
    public static ObjectIcapServergroup get(String name, Output<String> id, ObjectIcapServergroupState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:ObjectIcapServergroup    get:      id: ${id}
    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:
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-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.
    ObjectIcapServergroupId string
    an identifier for the resource with format {{name}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    ServerLists List<ObjectIcapServergroupServerList>
    Server-List. The structure of server_list block is documented below.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-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.
    ObjectIcapServergroupId string
    an identifier for the resource with format {{name}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    ServerLists []ObjectIcapServergroupServerListTypeArgs
    Server-List. The structure of server_list block is documented below.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-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.
    objectIcapServergroupId String
    an identifier for the resource with format {{name}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    serverLists List<ObjectIcapServergroupServerList>
    Server-List. The structure of server_list block is documented below.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    dynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-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.
    objectIcapServergroupId string
    an identifier for the resource with format {{name}}.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    serverLists ObjectIcapServergroupServerList[]
    Server-List. The structure of server_list block is documented below.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    dynamic_sort_subtable str
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-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.
    object_icap_servergroup_id str
    an identifier for the resource with format {{name}}.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    server_lists Sequence[ObjectIcapServergroupServerListArgs]
    Server-List. The structure of server_list block is documented below.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-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.
    objectIcapServergroupId String
    an identifier for the resource with format {{name}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    serverLists List<Property Map>
    Server-List. The structure of server_list block is documented below.

    Supporting Types

    ObjectIcapServergroupServerList, ObjectIcapServergroupServerListArgs

    Names List<string>
    ICAP server name.
    Weight double
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    Names []string
    ICAP server name.
    Weight float64
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    names List<String>
    ICAP server name.
    weight Double
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    names string[]
    ICAP server name.
    weight number
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    names Sequence[str]
    ICAP server name.
    weight float
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    names List<String>
    ICAP server name.
    weight Number
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).

    Import

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

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/objectIcapServergroup:ObjectIcapServergroup labelname {{name}}

    $ unset “FORTIMANAGER_IMPORT_TABLE”

    -> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    fortimanager fortinetdev/terraform-provider-fortimanager
    License
    Notes
    This Pulumi package is based on the fortimanager Terraform Provider.
    fortimanager logo
    fortimanager 1.15.0 published on Thursday, Nov 13, 2025 by fortinetdev
    Schema (JSON)
    fortinetdev/terraform-provider-fortimanager
      Meet Neo: Your AI Platform Teammate