@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
451 lines (450 loc) • 15.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Configure IPv6 firewall addresses.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fortios from "@pulumiverse/fortios";
*
* const trname = new fortios.firewall.Address6("trname", {
* cacheTtl: 0,
* color: 0,
* endIp: "::",
* host: "fdff:ffff::",
* hostType: "any",
* ip6: "fdff:ffff::/120",
* startIp: "fdff:ffff::",
* type: "ipprefix",
* visibility: "enable",
* });
* ```
*
* ## Import
*
* Firewall Address6 can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:firewall/address6:Address6 labelname {{name}}
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:firewall/address6:Address6 labelname {{name}}
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Address6 extends pulumi.CustomResource {
/**
* Get an existing Address6 resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: Address6State, opts?: pulumi.CustomResourceOptions): Address6;
/**
* Returns true if the given object is an instance of Address6. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Address6;
/**
* Minimal TTL of individual IPv6 addresses in FQDN cache.
*/
readonly cacheTtl: pulumi.Output<number>;
/**
* Integer value to determine the color of the icon in the GUI (range 1 to 32, default = 0, which sets the value to 1).
*/
readonly color: pulumi.Output<number>;
/**
* Comment.
*/
readonly comment: pulumi.Output<string | undefined>;
/**
* IPv6 addresses associated to a specific country.
*/
readonly country: pulumi.Output<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 ].
*/
readonly dynamicSortSubtable: pulumi.Output<string | undefined>;
/**
* Final IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx).
*/
readonly endIp: pulumi.Output<string>;
/**
* Last MAC address in the range.
*/
readonly endMac: pulumi.Output<string>;
/**
* Endpoint group name.
*/
readonly epgName: pulumi.Output<string>;
/**
* Security Fabric global object setting. Valid values: `enable`, `disable`.
*/
readonly fabricObject: pulumi.Output<string>;
/**
* Fully qualified domain name.
*/
readonly fqdn: pulumi.Output<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.
*/
readonly getAllTables: pulumi.Output<string | undefined>;
/**
* Host Address.
*/
readonly host: pulumi.Output<string>;
/**
* Host type. Valid values: `any`, `specific`.
*/
readonly hostType: pulumi.Output<string>;
/**
* IPv6 address prefix (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx).
*/
readonly ip6: pulumi.Output<string>;
/**
* IP address list. The structure of `list` block is documented below.
*/
readonly lists: pulumi.Output<outputs.firewall.Address6List[] | undefined>;
/**
* Multiple MAC address ranges. The structure of `macaddr` block is documented below.
*/
readonly macaddrs: pulumi.Output<outputs.firewall.Address6Macaddr[] | undefined>;
/**
* Address name.
*/
readonly name: pulumi.Output<string>;
/**
* Object ID for NSX.
*/
readonly objId: pulumi.Output<string | undefined>;
/**
* route-tag address.
*/
readonly routeTag: pulumi.Output<number>;
/**
* SDN.
*/
readonly sdn: pulumi.Output<string>;
/**
* SDN Tag.
*/
readonly sdnTag: pulumi.Output<string>;
/**
* First IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx).
*/
readonly startIp: pulumi.Output<string>;
/**
* First MAC address in the range.
*/
readonly startMac: pulumi.Output<string>;
/**
* IPv6 subnet segments. The structure of `subnetSegment` block is documented below.
*/
readonly subnetSegments: pulumi.Output<outputs.firewall.Address6SubnetSegment[] | undefined>;
/**
* Config object tagging The structure of `tagging` block is documented below.
*/
readonly taggings: pulumi.Output<outputs.firewall.Address6Tagging[] | undefined>;
/**
* IPv6 address template.
*/
readonly template: pulumi.Output<string>;
/**
* Tenant.
*/
readonly tenant: pulumi.Output<string>;
/**
* Type of IPv6 address object (default = ipprefix).
*/
readonly type: pulumi.Output<string>;
/**
* Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
*/
readonly uuid: pulumi.Output<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.
*/
readonly vdomparam: pulumi.Output<string>;
/**
* Enable/disable the visibility of the object in the GUI. Valid values: `enable`, `disable`.
*/
readonly visibility: pulumi.Output<string>;
/**
* Create a Address6 resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: Address6Args, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Address6 resources.
*/
export interface Address6State {
/**
* Minimal TTL of individual IPv6 addresses in FQDN cache.
*/
cacheTtl?: pulumi.Input<number>;
/**
* Integer value to determine the color of the icon in the GUI (range 1 to 32, default = 0, which sets the value to 1).
*/
color?: pulumi.Input<number>;
/**
* Comment.
*/
comment?: pulumi.Input<string>;
/**
* IPv6 addresses associated to a specific country.
*/
country?: pulumi.Input<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 ].
*/
dynamicSortSubtable?: pulumi.Input<string>;
/**
* Final IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx).
*/
endIp?: pulumi.Input<string>;
/**
* Last MAC address in the range.
*/
endMac?: pulumi.Input<string>;
/**
* Endpoint group name.
*/
epgName?: pulumi.Input<string>;
/**
* Security Fabric global object setting. Valid values: `enable`, `disable`.
*/
fabricObject?: pulumi.Input<string>;
/**
* Fully qualified domain name.
*/
fqdn?: pulumi.Input<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.
*/
getAllTables?: pulumi.Input<string>;
/**
* Host Address.
*/
host?: pulumi.Input<string>;
/**
* Host type. Valid values: `any`, `specific`.
*/
hostType?: pulumi.Input<string>;
/**
* IPv6 address prefix (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx).
*/
ip6?: pulumi.Input<string>;
/**
* IP address list. The structure of `list` block is documented below.
*/
lists?: pulumi.Input<pulumi.Input<inputs.firewall.Address6List>[]>;
/**
* Multiple MAC address ranges. The structure of `macaddr` block is documented below.
*/
macaddrs?: pulumi.Input<pulumi.Input<inputs.firewall.Address6Macaddr>[]>;
/**
* Address name.
*/
name?: pulumi.Input<string>;
/**
* Object ID for NSX.
*/
objId?: pulumi.Input<string>;
/**
* route-tag address.
*/
routeTag?: pulumi.Input<number>;
/**
* SDN.
*/
sdn?: pulumi.Input<string>;
/**
* SDN Tag.
*/
sdnTag?: pulumi.Input<string>;
/**
* First IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx).
*/
startIp?: pulumi.Input<string>;
/**
* First MAC address in the range.
*/
startMac?: pulumi.Input<string>;
/**
* IPv6 subnet segments. The structure of `subnetSegment` block is documented below.
*/
subnetSegments?: pulumi.Input<pulumi.Input<inputs.firewall.Address6SubnetSegment>[]>;
/**
* Config object tagging The structure of `tagging` block is documented below.
*/
taggings?: pulumi.Input<pulumi.Input<inputs.firewall.Address6Tagging>[]>;
/**
* IPv6 address template.
*/
template?: pulumi.Input<string>;
/**
* Tenant.
*/
tenant?: pulumi.Input<string>;
/**
* Type of IPv6 address object (default = ipprefix).
*/
type?: pulumi.Input<string>;
/**
* Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
*/
uuid?: pulumi.Input<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.
*/
vdomparam?: pulumi.Input<string>;
/**
* Enable/disable the visibility of the object in the GUI. Valid values: `enable`, `disable`.
*/
visibility?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Address6 resource.
*/
export interface Address6Args {
/**
* Minimal TTL of individual IPv6 addresses in FQDN cache.
*/
cacheTtl?: pulumi.Input<number>;
/**
* Integer value to determine the color of the icon in the GUI (range 1 to 32, default = 0, which sets the value to 1).
*/
color?: pulumi.Input<number>;
/**
* Comment.
*/
comment?: pulumi.Input<string>;
/**
* IPv6 addresses associated to a specific country.
*/
country?: pulumi.Input<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 ].
*/
dynamicSortSubtable?: pulumi.Input<string>;
/**
* Final IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx).
*/
endIp?: pulumi.Input<string>;
/**
* Last MAC address in the range.
*/
endMac?: pulumi.Input<string>;
/**
* Endpoint group name.
*/
epgName?: pulumi.Input<string>;
/**
* Security Fabric global object setting. Valid values: `enable`, `disable`.
*/
fabricObject?: pulumi.Input<string>;
/**
* Fully qualified domain name.
*/
fqdn?: pulumi.Input<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.
*/
getAllTables?: pulumi.Input<string>;
/**
* Host Address.
*/
host?: pulumi.Input<string>;
/**
* Host type. Valid values: `any`, `specific`.
*/
hostType?: pulumi.Input<string>;
/**
* IPv6 address prefix (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx).
*/
ip6?: pulumi.Input<string>;
/**
* IP address list. The structure of `list` block is documented below.
*/
lists?: pulumi.Input<pulumi.Input<inputs.firewall.Address6List>[]>;
/**
* Multiple MAC address ranges. The structure of `macaddr` block is documented below.
*/
macaddrs?: pulumi.Input<pulumi.Input<inputs.firewall.Address6Macaddr>[]>;
/**
* Address name.
*/
name?: pulumi.Input<string>;
/**
* Object ID for NSX.
*/
objId?: pulumi.Input<string>;
/**
* route-tag address.
*/
routeTag?: pulumi.Input<number>;
/**
* SDN.
*/
sdn?: pulumi.Input<string>;
/**
* SDN Tag.
*/
sdnTag?: pulumi.Input<string>;
/**
* First IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx).
*/
startIp?: pulumi.Input<string>;
/**
* First MAC address in the range.
*/
startMac?: pulumi.Input<string>;
/**
* IPv6 subnet segments. The structure of `subnetSegment` block is documented below.
*/
subnetSegments?: pulumi.Input<pulumi.Input<inputs.firewall.Address6SubnetSegment>[]>;
/**
* Config object tagging The structure of `tagging` block is documented below.
*/
taggings?: pulumi.Input<pulumi.Input<inputs.firewall.Address6Tagging>[]>;
/**
* IPv6 address template.
*/
template?: pulumi.Input<string>;
/**
* Tenant.
*/
tenant?: pulumi.Input<string>;
/**
* Type of IPv6 address object (default = ipprefix).
*/
type?: pulumi.Input<string>;
/**
* Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
*/
uuid?: pulumi.Input<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.
*/
vdomparam?: pulumi.Input<string>;
/**
* Enable/disable the visibility of the object in the GUI. Valid values: `enable`, `disable`.
*/
visibility?: pulumi.Input<string>;
}