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

fortimanager.ObjectIcapServergroupServerlist

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

    Add ICAP servers to a list to form a server group. Optionally assign weights to each server.

    This resource is a sub resource for variable server_list of resource fortimanager.ObjectIcapServergroup. Conflict and overwrite may occur if use both of them.

    Create ObjectIcapServergroupServerlist Resource

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

    Constructor syntax

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

@overload
def ObjectIcapServergroupServerlist(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    server_group: Optional[str] = None,
                                    adom: Optional[str] = None,
                                    name: Optional[str] = None,
                                    object_icap_servergroup_serverlist_id: Optional[str] = None,
                                    scopetype: Optional[str] = None,
                                    weight: Optional[float] = None)
    func NewObjectIcapServergroupServerlist(ctx *Context, name string, args ObjectIcapServergroupServerlistArgs, opts ...ResourceOption) (*ObjectIcapServergroupServerlist, error)
    public ObjectIcapServergroupServerlist(string name, ObjectIcapServergroupServerlistArgs args, CustomResourceOptions? opts = null)
    public ObjectIcapServergroupServerlist(String name, ObjectIcapServergroupServerlistArgs args)
public ObjectIcapServergroupServerlist(String name, ObjectIcapServergroupServerlistArgs args, CustomResourceOptions options)

    type: fortimanager:ObjectIcapServergroupServerlist
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 ObjectIcapServergroupServerlistArgs
    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 ObjectIcapServergroupServerlistArgs
    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 ObjectIcapServergroupServerlistArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectIcapServergroupServerlistArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectIcapServergroupServerlistArgs
    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 objectIcapServergroupServerlistResource = new Fortimanager.ObjectIcapServergroupServerlist("objectIcapServergroupServerlistResource", new()
{
    ServerGroup = "string",
    Adom = "string",
    Name = "string",
    ObjectIcapServergroupServerlistId = "string",
    Scopetype = "string",
    Weight = 0,
});

    example, err := fortimanager.NewObjectIcapServergroupServerlist(ctx, "objectIcapServergroupServerlistResource", &fortimanager.ObjectIcapServergroupServerlistArgs{
	ServerGroup:                       pulumi.String("string"),
	Adom:                              pulumi.String("string"),
	Name:                              pulumi.String("string"),
	ObjectIcapServergroupServerlistId: pulumi.String("string"),
	Scopetype:                         pulumi.String("string"),
	Weight:                            pulumi.Float64(0),
})

    var objectIcapServergroupServerlistResource = new ObjectIcapServergroupServerlist("objectIcapServergroupServerlistResource", ObjectIcapServergroupServerlistArgs.builder()
    .serverGroup("string")
    .adom("string")
    .name("string")
    .objectIcapServergroupServerlistId("string")
    .scopetype("string")
    .weight(0.0)
    .build());

    object_icap_servergroup_serverlist_resource = fortimanager.ObjectIcapServergroupServerlist("objectIcapServergroupServerlistResource",
    server_group="string",
    adom="string",
    name="string",
    object_icap_servergroup_serverlist_id="string",
    scopetype="string",
    weight=0)

    const objectIcapServergroupServerlistResource = new fortimanager.ObjectIcapServergroupServerlist("objectIcapServergroupServerlistResource", {
    serverGroup: "string",
    adom: "string",
    name: "string",
    objectIcapServergroupServerlistId: "string",
    scopetype: "string",
    weight: 0,
});

    type: fortimanager:ObjectIcapServergroupServerlist
properties:
    adom: string
    name: string
    objectIcapServergroupServerlistId: string
    scopetype: string
    serverGroup: string
    weight: 0

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

    ServerGroup string
    Server Group.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Name string
    ICAP server name.
    ObjectIcapServergroupServerlistId 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.
    Weight double
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    ServerGroup string
    Server Group.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Name string
    ICAP server name.
    ObjectIcapServergroupServerlistId 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.
    Weight float64
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    serverGroup String
    Server Group.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    name String
    ICAP server name.
    objectIcapServergroupServerlistId 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.
    weight Double
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    serverGroup string
    Server Group.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    name string
    ICAP server name.
    objectIcapServergroupServerlistId 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.
    weight number
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    server_group str
    Server Group.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    name str
    ICAP server name.
    object_icap_servergroup_serverlist_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.
    weight float
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    serverGroup String
    Server Group.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    name String
    ICAP server name.
    objectIcapServergroupServerlistId 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.
    weight Number
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).

    Outputs

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

    Get an existing ObjectIcapServergroupServerlist 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?: ObjectIcapServergroupServerlistState, opts?: CustomResourceOptions): ObjectIcapServergroupServerlist
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        name: Optional[str] = None,
        object_icap_servergroup_serverlist_id: Optional[str] = None,
        scopetype: Optional[str] = None,
        server_group: Optional[str] = None,
        weight: Optional[float] = None) -> ObjectIcapServergroupServerlist
    func GetObjectIcapServergroupServerlist(ctx *Context, name string, id IDInput, state *ObjectIcapServergroupServerlistState, opts ...ResourceOption) (*ObjectIcapServergroupServerlist, error)
    public static ObjectIcapServergroupServerlist Get(string name, Input<string> id, ObjectIcapServergroupServerlistState? state, CustomResourceOptions? opts = null)
    public static ObjectIcapServergroupServerlist get(String name, Output<String> id, ObjectIcapServergroupServerlistState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:ObjectIcapServergroupServerlist    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.
    Name string
    ICAP server name.
    ObjectIcapServergroupServerlistId 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.
    ServerGroup string
    Server Group.
    Weight double
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Name string
    ICAP server name.
    ObjectIcapServergroupServerlistId 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.
    ServerGroup string
    Server Group.
    Weight float64
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    name String
    ICAP server name.
    objectIcapServergroupServerlistId 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.
    serverGroup String
    Server Group.
    weight Double
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    name string
    ICAP server name.
    objectIcapServergroupServerlistId 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.
    serverGroup string
    Server Group.
    weight number
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    name str
    ICAP server name.
    object_icap_servergroup_serverlist_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_group str
    Server Group.
    weight float
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    name String
    ICAP server name.
    objectIcapServergroupServerlistId 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.
    serverGroup String
    Server Group.
    weight Number
    Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100, default = 10).

    Import

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

    Set import_options = [“server_group=YOUR_VALUE”] in the provider section.

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/objectIcapServergroupServerlist:ObjectIcapServergroupServerlist 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