@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
228 lines (227 loc) • 10.7 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Independent upgrades for managed devices. Applies to FortiOS Version `>= 7.2.4`.
*
* ## Import
*
* System DeviceUpgrade can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:system/deviceupgrade:Deviceupgrade labelname {{serial}}
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:system/deviceupgrade:Deviceupgrade labelname {{serial}}
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Deviceupgrade extends pulumi.CustomResource {
/**
* Get an existing Deviceupgrade 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?: DeviceupgradeState, opts?: pulumi.CustomResourceOptions): Deviceupgrade;
/**
* Returns true if the given object is an instance of Deviceupgrade. 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 Deviceupgrade;
/**
* Fortinet device type.
*/
readonly deviceType: 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>;
/**
* Upgrade failure reason.
*/
readonly failureReason: 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>;
/**
* Serial number of the FortiGate unit that will control the reboot process for the federated upgrade of the HA cluster.
*/
readonly haRebootController: pulumi.Output<string>;
/**
* Known members of the HA cluster. If a member is missing at upgrade time, the upgrade will be cancelled. The structure of `knownHaMembers` block is documented below.
*/
readonly knownHaMembers: pulumi.Output<outputs.system.DeviceupgradeKnownHaMember[] | undefined>;
/**
* Maximum number of minutes to allow for immediate upgrade preparation.
*/
readonly maximumMinutes: pulumi.Output<number>;
/**
* Serial number of the node to include.
*/
readonly serial: pulumi.Output<string>;
/**
* Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC).
*/
readonly setupTime: pulumi.Output<string>;
/**
* Current status of the upgrade. Valid values: `disabled`, `initialized`, `downloading`, `device-disconnected`, `ready`, `coordinating`, `staging`, `final-check`, `upgrade-devices`, `cancelled`, `confirmed`, `done`, `failed`.
*/
readonly status: pulumi.Output<string>;
/**
* Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
*/
readonly time: pulumi.Output<string>;
/**
* Run immediately or at a scheduled time. Valid values: `immediate`, `scheduled`.
*/
readonly timing: pulumi.Output<string>;
/**
* Fortinet OS image versions to upgrade through in major-minor-patch format, such as 7-0-4.
*/
readonly upgradePath: 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>;
/**
* Create a Deviceupgrade 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?: DeviceupgradeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Deviceupgrade resources.
*/
export interface DeviceupgradeState {
/**
* Fortinet device type.
*/
deviceType?: 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>;
/**
* Upgrade failure reason.
*/
failureReason?: 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>;
/**
* Serial number of the FortiGate unit that will control the reboot process for the federated upgrade of the HA cluster.
*/
haRebootController?: pulumi.Input<string>;
/**
* Known members of the HA cluster. If a member is missing at upgrade time, the upgrade will be cancelled. The structure of `knownHaMembers` block is documented below.
*/
knownHaMembers?: pulumi.Input<pulumi.Input<inputs.system.DeviceupgradeKnownHaMember>[]>;
/**
* Maximum number of minutes to allow for immediate upgrade preparation.
*/
maximumMinutes?: pulumi.Input<number>;
/**
* Serial number of the node to include.
*/
serial?: pulumi.Input<string>;
/**
* Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC).
*/
setupTime?: pulumi.Input<string>;
/**
* Current status of the upgrade. Valid values: `disabled`, `initialized`, `downloading`, `device-disconnected`, `ready`, `coordinating`, `staging`, `final-check`, `upgrade-devices`, `cancelled`, `confirmed`, `done`, `failed`.
*/
status?: pulumi.Input<string>;
/**
* Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
*/
time?: pulumi.Input<string>;
/**
* Run immediately or at a scheduled time. Valid values: `immediate`, `scheduled`.
*/
timing?: pulumi.Input<string>;
/**
* Fortinet OS image versions to upgrade through in major-minor-patch format, such as 7-0-4.
*/
upgradePath?: 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>;
}
/**
* The set of arguments for constructing a Deviceupgrade resource.
*/
export interface DeviceupgradeArgs {
/**
* Fortinet device type.
*/
deviceType?: 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>;
/**
* Upgrade failure reason.
*/
failureReason?: 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>;
/**
* Serial number of the FortiGate unit that will control the reboot process for the federated upgrade of the HA cluster.
*/
haRebootController?: pulumi.Input<string>;
/**
* Known members of the HA cluster. If a member is missing at upgrade time, the upgrade will be cancelled. The structure of `knownHaMembers` block is documented below.
*/
knownHaMembers?: pulumi.Input<pulumi.Input<inputs.system.DeviceupgradeKnownHaMember>[]>;
/**
* Maximum number of minutes to allow for immediate upgrade preparation.
*/
maximumMinutes?: pulumi.Input<number>;
/**
* Serial number of the node to include.
*/
serial?: pulumi.Input<string>;
/**
* Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC).
*/
setupTime?: pulumi.Input<string>;
/**
* Current status of the upgrade. Valid values: `disabled`, `initialized`, `downloading`, `device-disconnected`, `ready`, `coordinating`, `staging`, `final-check`, `upgrade-devices`, `cancelled`, `confirmed`, `done`, `failed`.
*/
status?: pulumi.Input<string>;
/**
* Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
*/
time?: pulumi.Input<string>;
/**
* Run immediately or at a scheduled time. Valid values: `immediate`, `scheduled`.
*/
timing?: pulumi.Input<string>;
/**
* Fortinet OS image versions to upgrade through in major-minor-patch format, such as 7-0-4.
*/
upgradePath?: 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>;
}