Docs Packages
  1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. Ipam
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.system.Ipam

Explore with Pulumi AI

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

    Configure IP address management services. Applies to FortiOS Version >= 7.0.2.

    Create Ipam Resource

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

    Constructor syntax

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

@overload
def Ipam(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         automatic_conflict_resolution: Optional[str] = None,
         dynamic_sort_subtable: Optional[str] = None,
         get_all_tables: Optional[str] = None,
         manage_lan_addresses: Optional[str] = None,
         manage_lan_extension_addresses: Optional[str] = None,
         manage_ssid_addresses: Optional[str] = None,
         pool_subnet: Optional[str] = None,
         pools: Optional[Sequence[IpamPoolArgs]] = None,
         require_subnet_size_match: Optional[str] = None,
         rules: Optional[Sequence[IpamRuleArgs]] = None,
         server_type: Optional[str] = None,
         status: Optional[str] = None,
         vdomparam: Optional[str] = None)
    func NewIpam(ctx *Context, name string, args *IpamArgs, opts ...ResourceOption) (*Ipam, error)
    public Ipam(string name, IpamArgs? args = null, CustomResourceOptions? opts = null)
    public Ipam(String name, IpamArgs args)
public Ipam(String name, IpamArgs args, CustomResourceOptions options)

    type: fortios:system:Ipam
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 IpamArgs
    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 IpamArgs
    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 IpamArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpamArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpamArgs
    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 ipamResource = new Fortios.System.Ipam("ipamResource", new()
{
    AutomaticConflictResolution = "string",
    DynamicSortSubtable = "string",
    GetAllTables = "string",
    ManageLanAddresses = "string",
    ManageLanExtensionAddresses = "string",
    ManageSsidAddresses = "string",
    PoolSubnet = "string",
    Pools = new[]
    {
        new Fortios.System.Inputs.IpamPoolArgs
        {
            Description = "string",
            Name = "string",
            Subnet = "string",
        },
    },
    RequireSubnetSizeMatch = "string",
    Rules = new[]
    {
        new Fortios.System.Inputs.IpamRuleArgs
        {
            Description = "string",
            Devices = new[]
            {
                new Fortios.System.Inputs.IpamRuleDeviceArgs
                {
                    Name = "string",
                },
            },
            Dhcp = "string",
            Interfaces = new[]
            {
                new Fortios.System.Inputs.IpamRuleInterfaceArgs
                {
                    Name = "string",
                },
            },
            Name = "string",
            Pools = new[]
            {
                new Fortios.System.Inputs.IpamRulePoolArgs
                {
                    Name = "string",
                },
            },
            Role = "string",
        },
    },
    ServerType = "string",
    Status = "string",
    Vdomparam = "string",
});

    example, err := system.NewIpam(ctx, "ipamResource", &system.IpamArgs{
	AutomaticConflictResolution: pulumi.String("string"),
	DynamicSortSubtable:         pulumi.String("string"),
	GetAllTables:                pulumi.String("string"),
	ManageLanAddresses:          pulumi.String("string"),
	ManageLanExtensionAddresses: pulumi.String("string"),
	ManageSsidAddresses:         pulumi.String("string"),
	PoolSubnet:                  pulumi.String("string"),
	Pools: system.IpamPoolArray{
		&system.IpamPoolArgs{
			Description: pulumi.String("string"),
			Name:        pulumi.String("string"),
			Subnet:      pulumi.String("string"),
		},
	},
	RequireSubnetSizeMatch: pulumi.String("string"),
	Rules: system.IpamRuleArray{
		&system.IpamRuleArgs{
			Description: pulumi.String("string"),
			Devices: system.IpamRuleDeviceArray{
				&system.IpamRuleDeviceArgs{
					Name: pulumi.String("string"),
				},
			},
			Dhcp: pulumi.String("string"),
			Interfaces: system.IpamRuleInterfaceArray{
				&system.IpamRuleInterfaceArgs{
					Name: pulumi.String("string"),
				},
			},
			Name: pulumi.String("string"),
			Pools: system.IpamRulePoolArray{
				&system.IpamRulePoolArgs{
					Name: pulumi.String("string"),
				},
			},
			Role: pulumi.String("string"),
		},
	},
	ServerType: pulumi.String("string"),
	Status:     pulumi.String("string"),
	Vdomparam:  pulumi.String("string"),
})

    var ipamResource = new Ipam("ipamResource", IpamArgs.builder()
    .automaticConflictResolution("string")
    .dynamicSortSubtable("string")
    .getAllTables("string")
    .manageLanAddresses("string")
    .manageLanExtensionAddresses("string")
    .manageSsidAddresses("string")
    .poolSubnet("string")
    .pools(IpamPoolArgs.builder()
        .description("string")
        .name("string")
        .subnet("string")
        .build())
    .requireSubnetSizeMatch("string")
    .rules(IpamRuleArgs.builder()
        .description("string")
        .devices(IpamRuleDeviceArgs.builder()
            .name("string")
            .build())
        .dhcp("string")
        .interfaces(IpamRuleInterfaceArgs.builder()
            .name("string")
            .build())
        .name("string")
        .pools(IpamRulePoolArgs.builder()
            .name("string")
            .build())
        .role("string")
        .build())
    .serverType("string")
    .status("string")
    .vdomparam("string")
    .build());

    ipam_resource = fortios.system.Ipam("ipamResource",
    automatic_conflict_resolution="string",
    dynamic_sort_subtable="string",
    get_all_tables="string",
    manage_lan_addresses="string",
    manage_lan_extension_addresses="string",
    manage_ssid_addresses="string",
    pool_subnet="string",
    pools=[fortios.system.IpamPoolArgs(
        description="string",
        name="string",
        subnet="string",
    )],
    require_subnet_size_match="string",
    rules=[fortios.system.IpamRuleArgs(
        description="string",
        devices=[fortios.system.IpamRuleDeviceArgs(
            name="string",
        )],
        dhcp="string",
        interfaces=[fortios.system.IpamRuleInterfaceArgs(
            name="string",
        )],
        name="string",
        pools=[fortios.system.IpamRulePoolArgs(
            name="string",
        )],
        role="string",
    )],
    server_type="string",
    status="string",
    vdomparam="string")

    const ipamResource = new fortios.system.Ipam("ipamResource", {
    automaticConflictResolution: "string",
    dynamicSortSubtable: "string",
    getAllTables: "string",
    manageLanAddresses: "string",
    manageLanExtensionAddresses: "string",
    manageSsidAddresses: "string",
    poolSubnet: "string",
    pools: [{
        description: "string",
        name: "string",
        subnet: "string",
    }],
    requireSubnetSizeMatch: "string",
    rules: [{
        description: "string",
        devices: [{
            name: "string",
        }],
        dhcp: "string",
        interfaces: [{
            name: "string",
        }],
        name: "string",
        pools: [{
            name: "string",
        }],
        role: "string",
    }],
    serverType: "string",
    status: "string",
    vdomparam: "string",
});

    type: fortios:system:Ipam
properties:
    automaticConflictResolution: string
    dynamicSortSubtable: string
    getAllTables: string
    manageLanAddresses: string
    manageLanExtensionAddresses: string
    manageSsidAddresses: string
    poolSubnet: string
    pools:
        - description: string
          name: string
          subnet: string
    requireSubnetSizeMatch: string
    rules:
        - description: string
          devices:
            - name: string
          dhcp: string
          interfaces:
            - name: string
          name: string
          pools:
            - name: string
          role: string
    serverType: string
    status: string
    vdomparam: string

    Ipam Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Ipam resource accepts the following input properties:

    AutomaticConflictResolution string
    Enable/disable automatic conflict resolution. Valid values: disable, enable.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    ManageLanAddresses string
    Enable/disable default management of LAN interface addresses. Valid values: disable, enable.
    ManageLanExtensionAddresses string
    Enable/disable default management of FortiExtender LAN extension interface addresses. Valid values: disable, enable.
    ManageSsidAddresses string
    Enable/disable default management of FortiAP SSID addresses. Valid values: disable, enable.
    PoolSubnet string
    Configure IPAM pool subnet, Class A - Class B subnet.
    Pools List<Pulumiverse.Fortios.System.Inputs.IpamPool>
    Configure IPAM pools. The structure of pools block is documented below.
    RequireSubnetSizeMatch string
    Enable/disable reassignment of subnets to make requested and actual sizes match. Valid values: disable, enable.
    Rules List<Pulumiverse.Fortios.System.Inputs.IpamRule>
    Configure IPAM allocation rules. The structure of rules block is documented below.
    ServerType string
    Configure the type of IPAM server to use.
    Status string
    Enable/disable IP address management services. Valid values: enable, disable.
    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.
    AutomaticConflictResolution string
    Enable/disable automatic conflict resolution. Valid values: disable, enable.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    ManageLanAddresses string
    Enable/disable default management of LAN interface addresses. Valid values: disable, enable.
    ManageLanExtensionAddresses string
    Enable/disable default management of FortiExtender LAN extension interface addresses. Valid values: disable, enable.
    ManageSsidAddresses string
    Enable/disable default management of FortiAP SSID addresses. Valid values: disable, enable.
    PoolSubnet string
    Configure IPAM pool subnet, Class A - Class B subnet.
    Pools []IpamPoolArgs
    Configure IPAM pools. The structure of pools block is documented below.
    RequireSubnetSizeMatch string
    Enable/disable reassignment of subnets to make requested and actual sizes match. Valid values: disable, enable.
    Rules []IpamRuleArgs
    Configure IPAM allocation rules. The structure of rules block is documented below.
    ServerType string
    Configure the type of IPAM server to use.
    Status string
    Enable/disable IP address management services. Valid values: enable, disable.
    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.
    automaticConflictResolution String
    Enable/disable automatic conflict resolution. Valid values: disable, enable.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    manageLanAddresses String
    Enable/disable default management of LAN interface addresses. Valid values: disable, enable.
    manageLanExtensionAddresses String
    Enable/disable default management of FortiExtender LAN extension interface addresses. Valid values: disable, enable.
    manageSsidAddresses String
    Enable/disable default management of FortiAP SSID addresses. Valid values: disable, enable.
    poolSubnet String
    Configure IPAM pool subnet, Class A - Class B subnet.
    pools List<IpamPool>
    Configure IPAM pools. The structure of pools block is documented below.
    requireSubnetSizeMatch String
    Enable/disable reassignment of subnets to make requested and actual sizes match. Valid values: disable, enable.
    rules List<IpamRule>
    Configure IPAM allocation rules. The structure of rules block is documented below.
    serverType String
    Configure the type of IPAM server to use.
    status String
    Enable/disable IP address management services. Valid values: enable, disable.
    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.
    automaticConflictResolution string
    Enable/disable automatic conflict resolution. Valid values: disable, enable.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    manageLanAddresses string
    Enable/disable default management of LAN interface addresses. Valid values: disable, enable.
    manageLanExtensionAddresses string
    Enable/disable default management of FortiExtender LAN extension interface addresses. Valid values: disable, enable.
    manageSsidAddresses string
    Enable/disable default management of FortiAP SSID addresses. Valid values: disable, enable.
    poolSubnet string
    Configure IPAM pool subnet, Class A - Class B subnet.
    pools IpamPool[]
    Configure IPAM pools. The structure of pools block is documented below.
    requireSubnetSizeMatch string
    Enable/disable reassignment of subnets to make requested and actual sizes match. Valid values: disable, enable.
    rules IpamRule[]
    Configure IPAM allocation rules. The structure of rules block is documented below.
    serverType string
    Configure the type of IPAM server to use.
    status string
    Enable/disable IP address management services. Valid values: enable, disable.
    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.
    automatic_conflict_resolution str
    Enable/disable automatic conflict resolution. Valid values: disable, enable.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    manage_lan_addresses str
    Enable/disable default management of LAN interface addresses. Valid values: disable, enable.
    manage_lan_extension_addresses str
    Enable/disable default management of FortiExtender LAN extension interface addresses. Valid values: disable, enable.
    manage_ssid_addresses str
    Enable/disable default management of FortiAP SSID addresses. Valid values: disable, enable.
    pool_subnet str
    Configure IPAM pool subnet, Class A - Class B subnet.
    pools Sequence[IpamPoolArgs]
    Configure IPAM pools. The structure of pools block is documented below.
    require_subnet_size_match str
    Enable/disable reassignment of subnets to make requested and actual sizes match. Valid values: disable, enable.
    rules Sequence[IpamRuleArgs]
    Configure IPAM allocation rules. The structure of rules block is documented below.
    server_type str
    Configure the type of IPAM server to use.
    status str
    Enable/disable IP address management services. Valid values: enable, disable.
    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.
    automaticConflictResolution String
    Enable/disable automatic conflict resolution. Valid values: disable, enable.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    manageLanAddresses String
    Enable/disable default management of LAN interface addresses. Valid values: disable, enable.
    manageLanExtensionAddresses String
    Enable/disable default management of FortiExtender LAN extension interface addresses. Valid values: disable, enable.
    manageSsidAddresses String
    Enable/disable default management of FortiAP SSID addresses. Valid values: disable, enable.
    poolSubnet String
    Configure IPAM pool subnet, Class A - Class B subnet.
    pools List<Property Map>
    Configure IPAM pools. The structure of pools block is documented below.
    requireSubnetSizeMatch String
    Enable/disable reassignment of subnets to make requested and actual sizes match. Valid values: disable, enable.
    rules List<Property Map>
    Configure IPAM allocation rules. The structure of rules block is documented below.
    serverType String
    Configure the type of IPAM server to use.
    status String
    Enable/disable IP address management services. Valid values: enable, disable.
    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 Ipam 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 Ipam Resource

    Get an existing Ipam 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?: IpamState, opts?: CustomResourceOptions): Ipam
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        automatic_conflict_resolution: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        manage_lan_addresses: Optional[str] = None,
        manage_lan_extension_addresses: Optional[str] = None,
        manage_ssid_addresses: Optional[str] = None,
        pool_subnet: Optional[str] = None,
        pools: Optional[Sequence[IpamPoolArgs]] = None,
        require_subnet_size_match: Optional[str] = None,
        rules: Optional[Sequence[IpamRuleArgs]] = None,
        server_type: Optional[str] = None,
        status: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Ipam
    func GetIpam(ctx *Context, name string, id IDInput, state *IpamState, opts ...ResourceOption) (*Ipam, error)
    public static Ipam Get(string name, Input<string> id, IpamState? state, CustomResourceOptions? opts = null)
    public static Ipam get(String name, Output<String> id, IpamState 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:
    AutomaticConflictResolution string
    Enable/disable automatic conflict resolution. Valid values: disable, enable.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    ManageLanAddresses string
    Enable/disable default management of LAN interface addresses. Valid values: disable, enable.
    ManageLanExtensionAddresses string
    Enable/disable default management of FortiExtender LAN extension interface addresses. Valid values: disable, enable.
    ManageSsidAddresses string
    Enable/disable default management of FortiAP SSID addresses. Valid values: disable, enable.
    PoolSubnet string
    Configure IPAM pool subnet, Class A - Class B subnet.
    Pools List<Pulumiverse.Fortios.System.Inputs.IpamPool>
    Configure IPAM pools. The structure of pools block is documented below.
    RequireSubnetSizeMatch string
    Enable/disable reassignment of subnets to make requested and actual sizes match. Valid values: disable, enable.
    Rules List<Pulumiverse.Fortios.System.Inputs.IpamRule>
    Configure IPAM allocation rules. The structure of rules block is documented below.
    ServerType string
    Configure the type of IPAM server to use.
    Status string
    Enable/disable IP address management services. Valid values: enable, disable.
    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.
    AutomaticConflictResolution string
    Enable/disable automatic conflict resolution. Valid values: disable, enable.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    ManageLanAddresses string
    Enable/disable default management of LAN interface addresses. Valid values: disable, enable.
    ManageLanExtensionAddresses string
    Enable/disable default management of FortiExtender LAN extension interface addresses. Valid values: disable, enable.
    ManageSsidAddresses string
    Enable/disable default management of FortiAP SSID addresses. Valid values: disable, enable.
    PoolSubnet string
    Configure IPAM pool subnet, Class A - Class B subnet.
    Pools []IpamPoolArgs
    Configure IPAM pools. The structure of pools block is documented below.
    RequireSubnetSizeMatch string
    Enable/disable reassignment of subnets to make requested and actual sizes match. Valid values: disable, enable.
    Rules []IpamRuleArgs
    Configure IPAM allocation rules. The structure of rules block is documented below.
    ServerType string
    Configure the type of IPAM server to use.
    Status string
    Enable/disable IP address management services. Valid values: enable, disable.
    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.
    automaticConflictResolution String
    Enable/disable automatic conflict resolution. Valid values: disable, enable.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    manageLanAddresses String
    Enable/disable default management of LAN interface addresses. Valid values: disable, enable.
    manageLanExtensionAddresses String
    Enable/disable default management of FortiExtender LAN extension interface addresses. Valid values: disable, enable.
    manageSsidAddresses String
    Enable/disable default management of FortiAP SSID addresses. Valid values: disable, enable.
    poolSubnet String
    Configure IPAM pool subnet, Class A - Class B subnet.
    pools List<IpamPool>
    Configure IPAM pools. The structure of pools block is documented below.
    requireSubnetSizeMatch String
    Enable/disable reassignment of subnets to make requested and actual sizes match. Valid values: disable, enable.
    rules List<IpamRule>
    Configure IPAM allocation rules. The structure of rules block is documented below.
    serverType String
    Configure the type of IPAM server to use.
    status String
    Enable/disable IP address management services. Valid values: enable, disable.
    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.
    automaticConflictResolution string
    Enable/disable automatic conflict resolution. Valid values: disable, enable.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    manageLanAddresses string
    Enable/disable default management of LAN interface addresses. Valid values: disable, enable.
    manageLanExtensionAddresses string
    Enable/disable default management of FortiExtender LAN extension interface addresses. Valid values: disable, enable.
    manageSsidAddresses string
    Enable/disable default management of FortiAP SSID addresses. Valid values: disable, enable.
    poolSubnet string
    Configure IPAM pool subnet, Class A - Class B subnet.
    pools IpamPool[]
    Configure IPAM pools. The structure of pools block is documented below.
    requireSubnetSizeMatch string
    Enable/disable reassignment of subnets to make requested and actual sizes match. Valid values: disable, enable.
    rules IpamRule[]
    Configure IPAM allocation rules. The structure of rules block is documented below.
    serverType string
    Configure the type of IPAM server to use.
    status string
    Enable/disable IP address management services. Valid values: enable, disable.
    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.
    automatic_conflict_resolution str
    Enable/disable automatic conflict resolution. Valid values: disable, enable.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    manage_lan_addresses str
    Enable/disable default management of LAN interface addresses. Valid values: disable, enable.
    manage_lan_extension_addresses str
    Enable/disable default management of FortiExtender LAN extension interface addresses. Valid values: disable, enable.
    manage_ssid_addresses str
    Enable/disable default management of FortiAP SSID addresses. Valid values: disable, enable.
    pool_subnet str
    Configure IPAM pool subnet, Class A - Class B subnet.
    pools Sequence[IpamPoolArgs]
    Configure IPAM pools. The structure of pools block is documented below.
    require_subnet_size_match str
    Enable/disable reassignment of subnets to make requested and actual sizes match. Valid values: disable, enable.
    rules Sequence[IpamRuleArgs]
    Configure IPAM allocation rules. The structure of rules block is documented below.
    server_type str
    Configure the type of IPAM server to use.
    status str
    Enable/disable IP address management services. Valid values: enable, disable.
    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.
    automaticConflictResolution String
    Enable/disable automatic conflict resolution. Valid values: disable, enable.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    manageLanAddresses String
    Enable/disable default management of LAN interface addresses. Valid values: disable, enable.
    manageLanExtensionAddresses String
    Enable/disable default management of FortiExtender LAN extension interface addresses. Valid values: disable, enable.
    manageSsidAddresses String
    Enable/disable default management of FortiAP SSID addresses. Valid values: disable, enable.
    poolSubnet String
    Configure IPAM pool subnet, Class A - Class B subnet.
    pools List<Property Map>
    Configure IPAM pools. The structure of pools block is documented below.
    requireSubnetSizeMatch String
    Enable/disable reassignment of subnets to make requested and actual sizes match. Valid values: disable, enable.
    rules List<Property Map>
    Configure IPAM allocation rules. The structure of rules block is documented below.
    serverType String
    Configure the type of IPAM server to use.
    status String
    Enable/disable IP address management services. Valid values: enable, disable.
    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

    IpamPool, IpamPoolArgs

    Description string
    Description.
    Name string
    IPAM pool name.
    Subnet string
    Configure IPAM pool subnet, Class A - Class B subnet.
    Description string
    Description.
    Name string
    IPAM pool name.
    Subnet string
    Configure IPAM pool subnet, Class A - Class B subnet.
    description String
    Description.
    name String
    IPAM pool name.
    subnet String
    Configure IPAM pool subnet, Class A - Class B subnet.
    description string
    Description.
    name string
    IPAM pool name.
    subnet string
    Configure IPAM pool subnet, Class A - Class B subnet.
    description str
    Description.
    name str
    IPAM pool name.
    subnet str
    Configure IPAM pool subnet, Class A - Class B subnet.
    description String
    Description.
    name String
    IPAM pool name.
    subnet String
    Configure IPAM pool subnet, Class A - Class B subnet.

    IpamRule, IpamRuleArgs

    Description string
    Description.
    Devices List<Pulumiverse.Fortios.System.Inputs.IpamRuleDevice>
    Configure serial number or wildcard of Fortigate to match. The structure of device block is documented below.
    Dhcp string
    Enable/disable DHCP server for matching IPAM interfaces. Valid values: enable, disable.
    Interfaces List<Pulumiverse.Fortios.System.Inputs.IpamRuleInterface>
    Configure name or wildcard of interface to match. The structure of interface block is documented below.
    Name string
    IPAM rule name.
    Pools List<Pulumiverse.Fortios.System.Inputs.IpamRulePool>
    Configure name of IPAM pool to use. The structure of pool block is documented below.
    Role string
    Configure role of interface to match. Valid values: any, lan, wan, dmz, undefined.
    Description string
    Description.
    Devices []IpamRuleDevice
    Configure serial number or wildcard of Fortigate to match. The structure of device block is documented below.
    Dhcp string
    Enable/disable DHCP server for matching IPAM interfaces. Valid values: enable, disable.
    Interfaces []IpamRuleInterface
    Configure name or wildcard of interface to match. The structure of interface block is documented below.
    Name string
    IPAM rule name.
    Pools []IpamRulePool
    Configure name of IPAM pool to use. The structure of pool block is documented below.
    Role string
    Configure role of interface to match. Valid values: any, lan, wan, dmz, undefined.
    description String
    Description.
    devices List<IpamRuleDevice>
    Configure serial number or wildcard of Fortigate to match. The structure of device block is documented below.
    dhcp String
    Enable/disable DHCP server for matching IPAM interfaces. Valid values: enable, disable.
    interfaces List<IpamRuleInterface>
    Configure name or wildcard of interface to match. The structure of interface block is documented below.
    name String
    IPAM rule name.
    pools List<IpamRulePool>
    Configure name of IPAM pool to use. The structure of pool block is documented below.
    role String
    Configure role of interface to match. Valid values: any, lan, wan, dmz, undefined.
    description string
    Description.
    devices IpamRuleDevice[]
    Configure serial number or wildcard of Fortigate to match. The structure of device block is documented below.
    dhcp string
    Enable/disable DHCP server for matching IPAM interfaces. Valid values: enable, disable.
    interfaces IpamRuleInterface[]
    Configure name or wildcard of interface to match. The structure of interface block is documented below.
    name string
    IPAM rule name.
    pools IpamRulePool[]
    Configure name of IPAM pool to use. The structure of pool block is documented below.
    role string
    Configure role of interface to match. Valid values: any, lan, wan, dmz, undefined.
    description str
    Description.
    devices Sequence[IpamRuleDevice]
    Configure serial number or wildcard of Fortigate to match. The structure of device block is documented below.
    dhcp str
    Enable/disable DHCP server for matching IPAM interfaces. Valid values: enable, disable.
    interfaces Sequence[IpamRuleInterface]
    Configure name or wildcard of interface to match. The structure of interface block is documented below.
    name str
    IPAM rule name.
    pools Sequence[IpamRulePool]
    Configure name of IPAM pool to use. The structure of pool block is documented below.
    role str
    Configure role of interface to match. Valid values: any, lan, wan, dmz, undefined.
    description String
    Description.
    devices List<Property Map>
    Configure serial number or wildcard of Fortigate to match. The structure of device block is documented below.
    dhcp String
    Enable/disable DHCP server for matching IPAM interfaces. Valid values: enable, disable.
    interfaces List<Property Map>
    Configure name or wildcard of interface to match. The structure of interface block is documented below.
    name String
    IPAM rule name.
    pools List<Property Map>
    Configure name of IPAM pool to use. The structure of pool block is documented below.
    role String
    Configure role of interface to match. Valid values: any, lan, wan, dmz, undefined.

    IpamRuleDevice, IpamRuleDeviceArgs

    Name string
    Fortigate serial number or wildcard.
    Name string
    Fortigate serial number or wildcard.
    name String
    Fortigate serial number or wildcard.
    name string
    Fortigate serial number or wildcard.
    name str
    Fortigate serial number or wildcard.
    name String
    Fortigate serial number or wildcard.

    IpamRuleInterface, IpamRuleInterfaceArgs

    Name string
    Interface name or wildcard.
    Name string
    Interface name or wildcard.
    name String
    Interface name or wildcard.
    name string
    Interface name or wildcard.
    name str
    Interface name or wildcard.
    name String
    Interface name or wildcard.

    IpamRulePool, IpamRulePoolArgs

    Name string
    Ipam pool name.
    Name string
    Ipam pool name.
    name String
    Ipam pool name.
    name string
    Ipam pool name.
    name str
    Ipam pool name.
    name String
    Ipam pool name.

    Import

    System Ipam can be imported using any of these accepted formats:

    $ pulumi import fortios:system/ipam:Ipam labelname SystemIpam

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/ipam:Ipam labelname SystemIpam

    $ unset “FORTIOS_IMPORT_TABLE”

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

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios