@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
762 lines (761 loc) • 25.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Extender controller configuration.
* The resource applies to FortiOS Version < 7.2.1. For FortiOS version >= 7.2.1, see `fortios.extensioncontroller.Extender`
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fortios from "@pulumiverse/fortios";
*
* const trname = new fortios.extendercontroller.Extender("trname", {
* admin: "disable",
* billingStartDay: 1,
* connStatus: 0,
* dialMode: "always-connect",
* dialStatus: 0,
* extName: "332",
* fosid: "1",
* initiatedUpdate: "disable",
* mode: "standalone",
* modemType: "gsm/lte",
* multiMode: "auto",
* pppAuthProtocol: "auto",
* pppEchoRequest: "disable",
* quotaLimitMb: 0,
* redial: "none",
* roaming: "disable",
* role: "primary",
* vdom: 0,
* wimaxAuthProtocol: "tls",
* });
* ```
*
* ## Import
*
* ExtenderController Extender can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:extendercontroller/extender:Extender labelname {{fosid}}
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:extendercontroller/extender:Extender labelname {{fosid}}
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Extender extends pulumi.CustomResource {
/**
* Get an existing Extender 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?: ExtenderState, opts?: pulumi.CustomResourceOptions): Extender;
/**
* Returns true if the given object is an instance of Extender. 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 Extender;
/**
* AAA shared secret.
*/
readonly aaaSharedSecret: pulumi.Output<string | undefined>;
/**
* Access point name(APN).
*/
readonly accessPointName: pulumi.Output<string>;
/**
* FortiExtender Administration (enable or disable). Valid values: `disable`, `discovered`, `enable`.
*/
readonly admin: pulumi.Output<string>;
/**
* Control management access to the managed extender. Separate entries with a space. Valid values: `ping`, `telnet`, `http`, `https`, `ssh`, `snmp`.
*/
readonly allowaccess: pulumi.Output<string>;
/**
* Initialization AT commands specific to the MODEM.
*/
readonly atDialScript: pulumi.Output<string>;
/**
* FortiExtender Administration (enable or disable). Valid values: `disable`, `enable`.
*/
readonly authorized: pulumi.Output<string>;
/**
* FortiExtender LAN extension bandwidth limit (Mbps).
*/
readonly bandwidthLimit: pulumi.Output<number>;
/**
* Billing start day.
*/
readonly billingStartDay: pulumi.Output<number>;
/**
* CDMA AAA SPI.
*/
readonly cdmaAaaSpi: pulumi.Output<string>;
/**
* CDMA HA SPI.
*/
readonly cdmaHaSpi: pulumi.Output<string>;
/**
* NAI for CDMA MODEMS.
*/
readonly cdmaNai: pulumi.Output<string>;
/**
* Connection status.
*/
readonly connStatus: pulumi.Output<number>;
/**
* FortiExtender controller report configuration. The structure of `controllerReport` block is documented below.
*/
readonly controllerReport: pulumi.Output<outputs.extendercontroller.ExtenderControllerReport>;
/**
* Description.
*/
readonly description: pulumi.Output<string>;
/**
* device-id
*/
readonly deviceId: pulumi.Output<number>;
/**
* Dial mode (dial-on-demand or always-connect). Valid values: `dial-on-demand`, `always-connect`.
*/
readonly dialMode: pulumi.Output<string>;
/**
* Dial status.
*/
readonly dialStatus: pulumi.Output<number>;
/**
* Enable/disable enforcement of bandwidth on LAN extension interface. Valid values: `enable`, `disable`.
*/
readonly enforceBandwidth: pulumi.Output<string>;
/**
* FortiExtender name.
*/
readonly extName: pulumi.Output<string>;
/**
* Extension type for this FortiExtender. Valid values: `wan-extension`, `lan-extension`.
*/
readonly extensionType: pulumi.Output<string>;
/**
* FortiExtender serial number.
*/
readonly fosid: 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>;
/**
* HA shared secret.
*/
readonly haSharedSecret: pulumi.Output<string | undefined>;
/**
* FortiExtender interface name.
*/
readonly ifname: pulumi.Output<string>;
/**
* Allow/disallow network initiated updates to the MODEM. Valid values: `enable`, `disable`.
*/
readonly initiatedUpdate: pulumi.Output<string>;
/**
* FortiExtender login password.
*/
readonly loginPassword: pulumi.Output<string | undefined>;
/**
* Change or reset the administrator password of a managed extender (yes, default, or no, default = no). Valid values: `yes`, `default`, `no`.
*/
readonly loginPasswordChange: pulumi.Output<string>;
/**
* FortiExtender mode. Valid values: `standalone`, `redundant`.
*/
readonly mode: pulumi.Output<string>;
/**
* Configuration options for modem 1. The structure of `modem1` block is documented below.
*/
readonly modem1: pulumi.Output<outputs.extendercontroller.ExtenderModem1>;
/**
* Configuration options for modem 2. The structure of `modem2` block is documented below.
*/
readonly modem2: pulumi.Output<outputs.extendercontroller.ExtenderModem2>;
/**
* MODEM password.
*/
readonly modemPasswd: pulumi.Output<string | undefined>;
/**
* MODEM type (CDMA, GSM/LTE or WIMAX). Valid values: `cdma`, `gsm/lte`, `wimax`.
*/
readonly modemType: pulumi.Output<string>;
/**
* MODEM mode of operation(3G,LTE,etc). Valid values: `auto`, `auto-3g`, `force-lte`, `force-3g`, `force-2g`.
*/
readonly multiMode: pulumi.Output<string>;
/**
* FortiExtender entry name.
*/
readonly name: pulumi.Output<string>;
/**
* Enable to override the extender profile management access configuration. Valid values: `enable`, `disable`.
*/
readonly overrideAllowaccess: pulumi.Output<string>;
/**
* Enable to override the extender profile enforce-bandwidth setting. Valid values: `enable`, `disable`.
*/
readonly overrideEnforceBandwidth: pulumi.Output<string>;
/**
* Enable to override the extender profile login-password (administrator password) setting. Valid values: `enable`, `disable`.
*/
readonly overrideLoginPasswordChange: pulumi.Output<string>;
/**
* PPP authentication protocol (PAP,CHAP or auto). Valid values: `auto`, `pap`, `chap`.
*/
readonly pppAuthProtocol: pulumi.Output<string>;
/**
* Enable/disable PPP echo request. Valid values: `enable`, `disable`.
*/
readonly pppEchoRequest: pulumi.Output<string>;
/**
* PPP password.
*/
readonly pppPassword: pulumi.Output<string | undefined>;
/**
* PPP username.
*/
readonly pppUsername: pulumi.Output<string>;
/**
* Primary HA.
*/
readonly primaryHa: pulumi.Output<string>;
/**
* FortiExtender profile configuration.
*/
readonly profile: pulumi.Output<string>;
/**
* Monthly quota limit (MB).
*/
readonly quotaLimitMb: pulumi.Output<number>;
/**
* Number of redials allowed based on failed attempts. Valid values: `none`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`.
*/
readonly redial: pulumi.Output<string>;
/**
* Redundant interface.
*/
readonly redundantIntf: pulumi.Output<string>;
/**
* Enable/disable MODEM roaming. Valid values: `enable`, `disable`.
*/
readonly roaming: pulumi.Output<string>;
/**
* FortiExtender work role(Primary, Secondary, None). Valid values: `none`, `primary`, `secondary`.
*/
readonly role: pulumi.Output<string>;
/**
* Secondary HA.
*/
readonly secondaryHa: pulumi.Output<string>;
/**
* SIM PIN.
*/
readonly simPin: pulumi.Output<string | undefined>;
/**
* VDOM
*/
readonly vdom: pulumi.Output<number>;
/**
* 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>;
/**
* FortiExtender wan extension configuration. The structure of `wanExtension` block is documented below.
*/
readonly wanExtension: pulumi.Output<outputs.extendercontroller.ExtenderWanExtension>;
/**
* WiMax authentication protocol(TLS or TTLS). Valid values: `tls`, `ttls`.
*/
readonly wimaxAuthProtocol: pulumi.Output<string>;
/**
* WiMax carrier.
*/
readonly wimaxCarrier: pulumi.Output<string>;
/**
* WiMax realm.
*/
readonly wimaxRealm: pulumi.Output<string>;
/**
* Create a Extender 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: ExtenderArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Extender resources.
*/
export interface ExtenderState {
/**
* AAA shared secret.
*/
aaaSharedSecret?: pulumi.Input<string>;
/**
* Access point name(APN).
*/
accessPointName?: pulumi.Input<string>;
/**
* FortiExtender Administration (enable or disable). Valid values: `disable`, `discovered`, `enable`.
*/
admin?: pulumi.Input<string>;
/**
* Control management access to the managed extender. Separate entries with a space. Valid values: `ping`, `telnet`, `http`, `https`, `ssh`, `snmp`.
*/
allowaccess?: pulumi.Input<string>;
/**
* Initialization AT commands specific to the MODEM.
*/
atDialScript?: pulumi.Input<string>;
/**
* FortiExtender Administration (enable or disable). Valid values: `disable`, `enable`.
*/
authorized?: pulumi.Input<string>;
/**
* FortiExtender LAN extension bandwidth limit (Mbps).
*/
bandwidthLimit?: pulumi.Input<number>;
/**
* Billing start day.
*/
billingStartDay?: pulumi.Input<number>;
/**
* CDMA AAA SPI.
*/
cdmaAaaSpi?: pulumi.Input<string>;
/**
* CDMA HA SPI.
*/
cdmaHaSpi?: pulumi.Input<string>;
/**
* NAI for CDMA MODEMS.
*/
cdmaNai?: pulumi.Input<string>;
/**
* Connection status.
*/
connStatus?: pulumi.Input<number>;
/**
* FortiExtender controller report configuration. The structure of `controllerReport` block is documented below.
*/
controllerReport?: pulumi.Input<inputs.extendercontroller.ExtenderControllerReport>;
/**
* Description.
*/
description?: pulumi.Input<string>;
/**
* device-id
*/
deviceId?: pulumi.Input<number>;
/**
* Dial mode (dial-on-demand or always-connect). Valid values: `dial-on-demand`, `always-connect`.
*/
dialMode?: pulumi.Input<string>;
/**
* Dial status.
*/
dialStatus?: pulumi.Input<number>;
/**
* Enable/disable enforcement of bandwidth on LAN extension interface. Valid values: `enable`, `disable`.
*/
enforceBandwidth?: pulumi.Input<string>;
/**
* FortiExtender name.
*/
extName?: pulumi.Input<string>;
/**
* Extension type for this FortiExtender. Valid values: `wan-extension`, `lan-extension`.
*/
extensionType?: pulumi.Input<string>;
/**
* FortiExtender serial number.
*/
fosid?: 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>;
/**
* HA shared secret.
*/
haSharedSecret?: pulumi.Input<string>;
/**
* FortiExtender interface name.
*/
ifname?: pulumi.Input<string>;
/**
* Allow/disallow network initiated updates to the MODEM. Valid values: `enable`, `disable`.
*/
initiatedUpdate?: pulumi.Input<string>;
/**
* FortiExtender login password.
*/
loginPassword?: pulumi.Input<string>;
/**
* Change or reset the administrator password of a managed extender (yes, default, or no, default = no). Valid values: `yes`, `default`, `no`.
*/
loginPasswordChange?: pulumi.Input<string>;
/**
* FortiExtender mode. Valid values: `standalone`, `redundant`.
*/
mode?: pulumi.Input<string>;
/**
* Configuration options for modem 1. The structure of `modem1` block is documented below.
*/
modem1?: pulumi.Input<inputs.extendercontroller.ExtenderModem1>;
/**
* Configuration options for modem 2. The structure of `modem2` block is documented below.
*/
modem2?: pulumi.Input<inputs.extendercontroller.ExtenderModem2>;
/**
* MODEM password.
*/
modemPasswd?: pulumi.Input<string>;
/**
* MODEM type (CDMA, GSM/LTE or WIMAX). Valid values: `cdma`, `gsm/lte`, `wimax`.
*/
modemType?: pulumi.Input<string>;
/**
* MODEM mode of operation(3G,LTE,etc). Valid values: `auto`, `auto-3g`, `force-lte`, `force-3g`, `force-2g`.
*/
multiMode?: pulumi.Input<string>;
/**
* FortiExtender entry name.
*/
name?: pulumi.Input<string>;
/**
* Enable to override the extender profile management access configuration. Valid values: `enable`, `disable`.
*/
overrideAllowaccess?: pulumi.Input<string>;
/**
* Enable to override the extender profile enforce-bandwidth setting. Valid values: `enable`, `disable`.
*/
overrideEnforceBandwidth?: pulumi.Input<string>;
/**
* Enable to override the extender profile login-password (administrator password) setting. Valid values: `enable`, `disable`.
*/
overrideLoginPasswordChange?: pulumi.Input<string>;
/**
* PPP authentication protocol (PAP,CHAP or auto). Valid values: `auto`, `pap`, `chap`.
*/
pppAuthProtocol?: pulumi.Input<string>;
/**
* Enable/disable PPP echo request. Valid values: `enable`, `disable`.
*/
pppEchoRequest?: pulumi.Input<string>;
/**
* PPP password.
*/
pppPassword?: pulumi.Input<string>;
/**
* PPP username.
*/
pppUsername?: pulumi.Input<string>;
/**
* Primary HA.
*/
primaryHa?: pulumi.Input<string>;
/**
* FortiExtender profile configuration.
*/
profile?: pulumi.Input<string>;
/**
* Monthly quota limit (MB).
*/
quotaLimitMb?: pulumi.Input<number>;
/**
* Number of redials allowed based on failed attempts. Valid values: `none`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`.
*/
redial?: pulumi.Input<string>;
/**
* Redundant interface.
*/
redundantIntf?: pulumi.Input<string>;
/**
* Enable/disable MODEM roaming. Valid values: `enable`, `disable`.
*/
roaming?: pulumi.Input<string>;
/**
* FortiExtender work role(Primary, Secondary, None). Valid values: `none`, `primary`, `secondary`.
*/
role?: pulumi.Input<string>;
/**
* Secondary HA.
*/
secondaryHa?: pulumi.Input<string>;
/**
* SIM PIN.
*/
simPin?: pulumi.Input<string>;
/**
* VDOM
*/
vdom?: pulumi.Input<number>;
/**
* 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>;
/**
* FortiExtender wan extension configuration. The structure of `wanExtension` block is documented below.
*/
wanExtension?: pulumi.Input<inputs.extendercontroller.ExtenderWanExtension>;
/**
* WiMax authentication protocol(TLS or TTLS). Valid values: `tls`, `ttls`.
*/
wimaxAuthProtocol?: pulumi.Input<string>;
/**
* WiMax carrier.
*/
wimaxCarrier?: pulumi.Input<string>;
/**
* WiMax realm.
*/
wimaxRealm?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Extender resource.
*/
export interface ExtenderArgs {
/**
* AAA shared secret.
*/
aaaSharedSecret?: pulumi.Input<string>;
/**
* Access point name(APN).
*/
accessPointName?: pulumi.Input<string>;
/**
* FortiExtender Administration (enable or disable). Valid values: `disable`, `discovered`, `enable`.
*/
admin: pulumi.Input<string>;
/**
* Control management access to the managed extender. Separate entries with a space. Valid values: `ping`, `telnet`, `http`, `https`, `ssh`, `snmp`.
*/
allowaccess?: pulumi.Input<string>;
/**
* Initialization AT commands specific to the MODEM.
*/
atDialScript?: pulumi.Input<string>;
/**
* FortiExtender Administration (enable or disable). Valid values: `disable`, `enable`.
*/
authorized?: pulumi.Input<string>;
/**
* FortiExtender LAN extension bandwidth limit (Mbps).
*/
bandwidthLimit?: pulumi.Input<number>;
/**
* Billing start day.
*/
billingStartDay?: pulumi.Input<number>;
/**
* CDMA AAA SPI.
*/
cdmaAaaSpi?: pulumi.Input<string>;
/**
* CDMA HA SPI.
*/
cdmaHaSpi?: pulumi.Input<string>;
/**
* NAI for CDMA MODEMS.
*/
cdmaNai?: pulumi.Input<string>;
/**
* Connection status.
*/
connStatus?: pulumi.Input<number>;
/**
* FortiExtender controller report configuration. The structure of `controllerReport` block is documented below.
*/
controllerReport?: pulumi.Input<inputs.extendercontroller.ExtenderControllerReport>;
/**
* Description.
*/
description?: pulumi.Input<string>;
/**
* device-id
*/
deviceId?: pulumi.Input<number>;
/**
* Dial mode (dial-on-demand or always-connect). Valid values: `dial-on-demand`, `always-connect`.
*/
dialMode?: pulumi.Input<string>;
/**
* Dial status.
*/
dialStatus?: pulumi.Input<number>;
/**
* Enable/disable enforcement of bandwidth on LAN extension interface. Valid values: `enable`, `disable`.
*/
enforceBandwidth?: pulumi.Input<string>;
/**
* FortiExtender name.
*/
extName?: pulumi.Input<string>;
/**
* Extension type for this FortiExtender. Valid values: `wan-extension`, `lan-extension`.
*/
extensionType?: pulumi.Input<string>;
/**
* FortiExtender serial number.
*/
fosid: 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>;
/**
* HA shared secret.
*/
haSharedSecret?: pulumi.Input<string>;
/**
* FortiExtender interface name.
*/
ifname?: pulumi.Input<string>;
/**
* Allow/disallow network initiated updates to the MODEM. Valid values: `enable`, `disable`.
*/
initiatedUpdate?: pulumi.Input<string>;
/**
* FortiExtender login password.
*/
loginPassword?: pulumi.Input<string>;
/**
* Change or reset the administrator password of a managed extender (yes, default, or no, default = no). Valid values: `yes`, `default`, `no`.
*/
loginPasswordChange?: pulumi.Input<string>;
/**
* FortiExtender mode. Valid values: `standalone`, `redundant`.
*/
mode?: pulumi.Input<string>;
/**
* Configuration options for modem 1. The structure of `modem1` block is documented below.
*/
modem1?: pulumi.Input<inputs.extendercontroller.ExtenderModem1>;
/**
* Configuration options for modem 2. The structure of `modem2` block is documented below.
*/
modem2?: pulumi.Input<inputs.extendercontroller.ExtenderModem2>;
/**
* MODEM password.
*/
modemPasswd?: pulumi.Input<string>;
/**
* MODEM type (CDMA, GSM/LTE or WIMAX). Valid values: `cdma`, `gsm/lte`, `wimax`.
*/
modemType?: pulumi.Input<string>;
/**
* MODEM mode of operation(3G,LTE,etc). Valid values: `auto`, `auto-3g`, `force-lte`, `force-3g`, `force-2g`.
*/
multiMode?: pulumi.Input<string>;
/**
* FortiExtender entry name.
*/
name?: pulumi.Input<string>;
/**
* Enable to override the extender profile management access configuration. Valid values: `enable`, `disable`.
*/
overrideAllowaccess?: pulumi.Input<string>;
/**
* Enable to override the extender profile enforce-bandwidth setting. Valid values: `enable`, `disable`.
*/
overrideEnforceBandwidth?: pulumi.Input<string>;
/**
* Enable to override the extender profile login-password (administrator password) setting. Valid values: `enable`, `disable`.
*/
overrideLoginPasswordChange?: pulumi.Input<string>;
/**
* PPP authentication protocol (PAP,CHAP or auto). Valid values: `auto`, `pap`, `chap`.
*/
pppAuthProtocol?: pulumi.Input<string>;
/**
* Enable/disable PPP echo request. Valid values: `enable`, `disable`.
*/
pppEchoRequest?: pulumi.Input<string>;
/**
* PPP password.
*/
pppPassword?: pulumi.Input<string>;
/**
* PPP username.
*/
pppUsername?: pulumi.Input<string>;
/**
* Primary HA.
*/
primaryHa?: pulumi.Input<string>;
/**
* FortiExtender profile configuration.
*/
profile?: pulumi.Input<string>;
/**
* Monthly quota limit (MB).
*/
quotaLimitMb?: pulumi.Input<number>;
/**
* Number of redials allowed based on failed attempts. Valid values: `none`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`.
*/
redial?: pulumi.Input<string>;
/**
* Redundant interface.
*/
redundantIntf?: pulumi.Input<string>;
/**
* Enable/disable MODEM roaming. Valid values: `enable`, `disable`.
*/
roaming?: pulumi.Input<string>;
/**
* FortiExtender work role(Primary, Secondary, None). Valid values: `none`, `primary`, `secondary`.
*/
role: pulumi.Input<string>;
/**
* Secondary HA.
*/
secondaryHa?: pulumi.Input<string>;
/**
* SIM PIN.
*/
simPin?: pulumi.Input<string>;
/**
* VDOM
*/
vdom?: pulumi.Input<number>;
/**
* 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>;
/**
* FortiExtender wan extension configuration. The structure of `wanExtension` block is documented below.
*/
wanExtension?: pulumi.Input<inputs.extendercontroller.ExtenderWanExtension>;
/**
* WiMax authentication protocol(TLS or TTLS). Valid values: `tls`, `ttls`.
*/
wimaxAuthProtocol?: pulumi.Input<string>;
/**
* WiMax carrier.
*/
wimaxCarrier?: pulumi.Input<string>;
/**
* WiMax realm.
*/
wimaxRealm?: pulumi.Input<string>;
}