Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. Deviceupgrade
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.system.Deviceupgrade

Explore with Pulumi AI

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

    Independent upgrades for managed devices. Applies to FortiOS Version >= 7.2.4.

    Create Deviceupgrade Resource

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

    Constructor syntax

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

@overload
def Deviceupgrade(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  device_type: Optional[str] = None,
                  dynamic_sort_subtable: Optional[str] = None,
                  failure_reason: Optional[str] = None,
                  get_all_tables: Optional[str] = None,
                  ha_reboot_controller: Optional[str] = None,
                  known_ha_members: Optional[Sequence[DeviceupgradeKnownHaMemberArgs]] = None,
                  maximum_minutes: Optional[int] = None,
                  serial: Optional[str] = None,
                  setup_time: Optional[str] = None,
                  status: Optional[str] = None,
                  time: Optional[str] = None,
                  timing: Optional[str] = None,
                  upgrade_path: Optional[str] = None,
                  vdomparam: Optional[str] = None)
    func NewDeviceupgrade(ctx *Context, name string, args *DeviceupgradeArgs, opts ...ResourceOption) (*Deviceupgrade, error)
    public Deviceupgrade(string name, DeviceupgradeArgs? args = null, CustomResourceOptions? opts = null)
    public Deviceupgrade(String name, DeviceupgradeArgs args)
public Deviceupgrade(String name, DeviceupgradeArgs args, CustomResourceOptions options)

    type: fortios:system:Deviceupgrade
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 DeviceupgradeArgs
    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 DeviceupgradeArgs
    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 DeviceupgradeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeviceupgradeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeviceupgradeArgs
    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 deviceupgradeResource = new Fortios.System.Deviceupgrade("deviceupgradeResource", new()
{
    DeviceType = "string",
    DynamicSortSubtable = "string",
    FailureReason = "string",
    GetAllTables = "string",
    HaRebootController = "string",
    KnownHaMembers = new[]
    {
        new Fortios.System.Inputs.DeviceupgradeKnownHaMemberArgs
        {
            Serial = "string",
        },
    },
    MaximumMinutes = 0,
    Serial = "string",
    SetupTime = "string",
    Status = "string",
    Time = "string",
    Timing = "string",
    UpgradePath = "string",
    Vdomparam = "string",
});

    example, err := system.NewDeviceupgrade(ctx, "deviceupgradeResource", &system.DeviceupgradeArgs{
	DeviceType:          pulumi.String("string"),
	DynamicSortSubtable: pulumi.String("string"),
	FailureReason:       pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	HaRebootController:  pulumi.String("string"),
	KnownHaMembers: system.DeviceupgradeKnownHaMemberArray{
		&system.DeviceupgradeKnownHaMemberArgs{
			Serial: pulumi.String("string"),
		},
	},
	MaximumMinutes: pulumi.Int(0),
	Serial:         pulumi.String("string"),
	SetupTime:      pulumi.String("string"),
	Status:         pulumi.String("string"),
	Time:           pulumi.String("string"),
	Timing:         pulumi.String("string"),
	UpgradePath:    pulumi.String("string"),
	Vdomparam:      pulumi.String("string"),
})

    var deviceupgradeResource = new Deviceupgrade("deviceupgradeResource", DeviceupgradeArgs.builder()
    .deviceType("string")
    .dynamicSortSubtable("string")
    .failureReason("string")
    .getAllTables("string")
    .haRebootController("string")
    .knownHaMembers(DeviceupgradeKnownHaMemberArgs.builder()
        .serial("string")
        .build())
    .maximumMinutes(0)
    .serial("string")
    .setupTime("string")
    .status("string")
    .time("string")
    .timing("string")
    .upgradePath("string")
    .vdomparam("string")
    .build());

    deviceupgrade_resource = fortios.system.Deviceupgrade("deviceupgradeResource",
    device_type="string",
    dynamic_sort_subtable="string",
    failure_reason="string",
    get_all_tables="string",
    ha_reboot_controller="string",
    known_ha_members=[{
        "serial": "string",
    }],
    maximum_minutes=0,
    serial="string",
    setup_time="string",
    status="string",
    time="string",
    timing="string",
    upgrade_path="string",
    vdomparam="string")

    const deviceupgradeResource = new fortios.system.Deviceupgrade("deviceupgradeResource", {
    deviceType: "string",
    dynamicSortSubtable: "string",
    failureReason: "string",
    getAllTables: "string",
    haRebootController: "string",
    knownHaMembers: [{
        serial: "string",
    }],
    maximumMinutes: 0,
    serial: "string",
    setupTime: "string",
    status: "string",
    time: "string",
    timing: "string",
    upgradePath: "string",
    vdomparam: "string",
});

    type: fortios:system:Deviceupgrade
properties:
    deviceType: string
    dynamicSortSubtable: string
    failureReason: string
    getAllTables: string
    haRebootController: string
    knownHaMembers:
        - serial: string
    maximumMinutes: 0
    serial: string
    setupTime: string
    status: string
    time: string
    timing: string
    upgradePath: string
    vdomparam: string

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

    DeviceType string
    Fortinet device type.
    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 ].
    FailureReason string
    Upgrade failure reason.
    GetAllTables 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.
    HaRebootController string
    Serial number of the FortiGate unit that will control the reboot process for the federated upgrade of the HA cluster.
    KnownHaMembers List<Pulumiverse.Fortios.System.Inputs.DeviceupgradeKnownHaMember>
    Known members of the HA cluster. If a member is missing at upgrade time, the upgrade will be cancelled. The structure of known_ha_members block is documented below.
    MaximumMinutes int
    Maximum number of minutes to allow for immediate upgrade preparation.
    Serial string
    Serial number of the node to include.
    SetupTime string
    Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC).
    Status string
    Current status of the upgrade. Valid values: disabled, initialized, downloading, device-disconnected, ready, coordinating, staging, final-check, upgrade-devices, cancelled, confirmed, done, failed.
    Time string
    Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
    Timing string
    Run immediately or at a scheduled time. Valid values: immediate, scheduled.
    UpgradePath string
    Fortinet OS image versions to upgrade through in major-minor-patch format, such as 7-0-4.
    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.
    DeviceType string
    Fortinet device type.
    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 ].
    FailureReason string
    Upgrade failure reason.
    GetAllTables 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.
    HaRebootController string
    Serial number of the FortiGate unit that will control the reboot process for the federated upgrade of the HA cluster.
    KnownHaMembers []DeviceupgradeKnownHaMemberArgs
    Known members of the HA cluster. If a member is missing at upgrade time, the upgrade will be cancelled. The structure of known_ha_members block is documented below.
    MaximumMinutes int
    Maximum number of minutes to allow for immediate upgrade preparation.
    Serial string
    Serial number of the node to include.
    SetupTime string
    Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC).
    Status string
    Current status of the upgrade. Valid values: disabled, initialized, downloading, device-disconnected, ready, coordinating, staging, final-check, upgrade-devices, cancelled, confirmed, done, failed.
    Time string
    Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
    Timing string
    Run immediately or at a scheduled time. Valid values: immediate, scheduled.
    UpgradePath string
    Fortinet OS image versions to upgrade through in major-minor-patch format, such as 7-0-4.
    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.
    deviceType String
    Fortinet device type.
    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 ].
    failureReason String
    Upgrade failure reason.
    getAllTables 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.
    haRebootController String
    Serial number of the FortiGate unit that will control the reboot process for the federated upgrade of the HA cluster.
    knownHaMembers List<DeviceupgradeKnownHaMember>
    Known members of the HA cluster. If a member is missing at upgrade time, the upgrade will be cancelled. The structure of known_ha_members block is documented below.
    maximumMinutes Integer
    Maximum number of minutes to allow for immediate upgrade preparation.
    serial String
    Serial number of the node to include.
    setupTime String
    Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC).
    status String
    Current status of the upgrade. Valid values: disabled, initialized, downloading, device-disconnected, ready, coordinating, staging, final-check, upgrade-devices, cancelled, confirmed, done, failed.
    time String
    Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
    timing String
    Run immediately or at a scheduled time. Valid values: immediate, scheduled.
    upgradePath String
    Fortinet OS image versions to upgrade through in major-minor-patch format, such as 7-0-4.
    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.
    deviceType string
    Fortinet device type.
    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 ].
    failureReason string
    Upgrade failure reason.
    getAllTables 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.
    haRebootController string
    Serial number of the FortiGate unit that will control the reboot process for the federated upgrade of the HA cluster.
    knownHaMembers DeviceupgradeKnownHaMember[]
    Known members of the HA cluster. If a member is missing at upgrade time, the upgrade will be cancelled. The structure of known_ha_members block is documented below.
    maximumMinutes number
    Maximum number of minutes to allow for immediate upgrade preparation.
    serial string
    Serial number of the node to include.
    setupTime string
    Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC).
    status string
    Current status of the upgrade. Valid values: disabled, initialized, downloading, device-disconnected, ready, coordinating, staging, final-check, upgrade-devices, cancelled, confirmed, done, failed.
    time string
    Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
    timing string
    Run immediately or at a scheduled time. Valid values: immediate, scheduled.
    upgradePath string
    Fortinet OS image versions to upgrade through in major-minor-patch format, such as 7-0-4.
    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.
    device_type str
    Fortinet device type.
    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 ].
    failure_reason str
    Upgrade failure reason.
    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, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    ha_reboot_controller str
    Serial number of the FortiGate unit that will control the reboot process for the federated upgrade of the HA cluster.
    known_ha_members Sequence[DeviceupgradeKnownHaMemberArgs]
    Known members of the HA cluster. If a member is missing at upgrade time, the upgrade will be cancelled. The structure of known_ha_members block is documented below.
    maximum_minutes int
    Maximum number of minutes to allow for immediate upgrade preparation.
    serial str
    Serial number of the node to include.
    setup_time str
    Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC).
    status str
    Current status of the upgrade. Valid values: disabled, initialized, downloading, device-disconnected, ready, coordinating, staging, final-check, upgrade-devices, cancelled, confirmed, done, failed.
    time str
    Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
    timing str
    Run immediately or at a scheduled time. Valid values: immediate, scheduled.
    upgrade_path str
    Fortinet OS image versions to upgrade through in major-minor-patch format, such as 7-0-4.
    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.
    deviceType String
    Fortinet device type.
    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 ].
    failureReason String
    Upgrade failure reason.
    getAllTables 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.
    haRebootController String
    Serial number of the FortiGate unit that will control the reboot process for the federated upgrade of the HA cluster.
    knownHaMembers List<Property Map>
    Known members of the HA cluster. If a member is missing at upgrade time, the upgrade will be cancelled. The structure of known_ha_members block is documented below.
    maximumMinutes Number
    Maximum number of minutes to allow for immediate upgrade preparation.
    serial String
    Serial number of the node to include.
    setupTime String
    Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC).
    status String
    Current status of the upgrade. Valid values: disabled, initialized, downloading, device-disconnected, ready, coordinating, staging, final-check, upgrade-devices, cancelled, confirmed, done, failed.
    time String
    Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
    timing String
    Run immediately or at a scheduled time. Valid values: immediate, scheduled.
    upgradePath String
    Fortinet OS image versions to upgrade through in major-minor-patch format, such as 7-0-4.
    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 Deviceupgrade 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 Deviceupgrade Resource

    Get an existing Deviceupgrade 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?: DeviceupgradeState, opts?: CustomResourceOptions): Deviceupgrade
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device_type: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        failure_reason: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        ha_reboot_controller: Optional[str] = None,
        known_ha_members: Optional[Sequence[DeviceupgradeKnownHaMemberArgs]] = None,
        maximum_minutes: Optional[int] = None,
        serial: Optional[str] = None,
        setup_time: Optional[str] = None,
        status: Optional[str] = None,
        time: Optional[str] = None,
        timing: Optional[str] = None,
        upgrade_path: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Deviceupgrade
    func GetDeviceupgrade(ctx *Context, name string, id IDInput, state *DeviceupgradeState, opts ...ResourceOption) (*Deviceupgrade, error)
    public static Deviceupgrade Get(string name, Input<string> id, DeviceupgradeState? state, CustomResourceOptions? opts = null)
    public static Deviceupgrade get(String name, Output<String> id, DeviceupgradeState 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:
    DeviceType string
    Fortinet device type.
    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 ].
    FailureReason string
    Upgrade failure reason.
    GetAllTables 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.
    HaRebootController string
    Serial number of the FortiGate unit that will control the reboot process for the federated upgrade of the HA cluster.
    KnownHaMembers List<Pulumiverse.Fortios.System.Inputs.DeviceupgradeKnownHaMember>
    Known members of the HA cluster. If a member is missing at upgrade time, the upgrade will be cancelled. The structure of known_ha_members block is documented below.
    MaximumMinutes int
    Maximum number of minutes to allow for immediate upgrade preparation.
    Serial string
    Serial number of the node to include.
    SetupTime string
    Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC).
    Status string
    Current status of the upgrade. Valid values: disabled, initialized, downloading, device-disconnected, ready, coordinating, staging, final-check, upgrade-devices, cancelled, confirmed, done, failed.
    Time string
    Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
    Timing string
    Run immediately or at a scheduled time. Valid values: immediate, scheduled.
    UpgradePath string
    Fortinet OS image versions to upgrade through in major-minor-patch format, such as 7-0-4.
    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.
    DeviceType string
    Fortinet device type.
    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 ].
    FailureReason string
    Upgrade failure reason.
    GetAllTables 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.
    HaRebootController string
    Serial number of the FortiGate unit that will control the reboot process for the federated upgrade of the HA cluster.
    KnownHaMembers []DeviceupgradeKnownHaMemberArgs
    Known members of the HA cluster. If a member is missing at upgrade time, the upgrade will be cancelled. The structure of known_ha_members block is documented below.
    MaximumMinutes int
    Maximum number of minutes to allow for immediate upgrade preparation.
    Serial string
    Serial number of the node to include.
    SetupTime string
    Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC).
    Status string
    Current status of the upgrade. Valid values: disabled, initialized, downloading, device-disconnected, ready, coordinating, staging, final-check, upgrade-devices, cancelled, confirmed, done, failed.
    Time string
    Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
    Timing string
    Run immediately or at a scheduled time. Valid values: immediate, scheduled.
    UpgradePath string
    Fortinet OS image versions to upgrade through in major-minor-patch format, such as 7-0-4.
    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.
    deviceType String
    Fortinet device type.
    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 ].
    failureReason String
    Upgrade failure reason.
    getAllTables 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.
    haRebootController String
    Serial number of the FortiGate unit that will control the reboot process for the federated upgrade of the HA cluster.
    knownHaMembers List<DeviceupgradeKnownHaMember>
    Known members of the HA cluster. If a member is missing at upgrade time, the upgrade will be cancelled. The structure of known_ha_members block is documented below.
    maximumMinutes Integer
    Maximum number of minutes to allow for immediate upgrade preparation.
    serial String
    Serial number of the node to include.
    setupTime String
    Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC).
    status String
    Current status of the upgrade. Valid values: disabled, initialized, downloading, device-disconnected, ready, coordinating, staging, final-check, upgrade-devices, cancelled, confirmed, done, failed.
    time String
    Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
    timing String
    Run immediately or at a scheduled time. Valid values: immediate, scheduled.
    upgradePath String
    Fortinet OS image versions to upgrade through in major-minor-patch format, such as 7-0-4.
    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.
    deviceType string
    Fortinet device type.
    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 ].
    failureReason string
    Upgrade failure reason.
    getAllTables 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.
    haRebootController string
    Serial number of the FortiGate unit that will control the reboot process for the federated upgrade of the HA cluster.
    knownHaMembers DeviceupgradeKnownHaMember[]
    Known members of the HA cluster. If a member is missing at upgrade time, the upgrade will be cancelled. The structure of known_ha_members block is documented below.
    maximumMinutes number
    Maximum number of minutes to allow for immediate upgrade preparation.
    serial string
    Serial number of the node to include.
    setupTime string
    Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC).
    status string
    Current status of the upgrade. Valid values: disabled, initialized, downloading, device-disconnected, ready, coordinating, staging, final-check, upgrade-devices, cancelled, confirmed, done, failed.
    time string
    Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
    timing string
    Run immediately or at a scheduled time. Valid values: immediate, scheduled.
    upgradePath string
    Fortinet OS image versions to upgrade through in major-minor-patch format, such as 7-0-4.
    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.
    device_type str
    Fortinet device type.
    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 ].
    failure_reason str
    Upgrade failure reason.
    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, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    ha_reboot_controller str
    Serial number of the FortiGate unit that will control the reboot process for the federated upgrade of the HA cluster.
    known_ha_members Sequence[DeviceupgradeKnownHaMemberArgs]
    Known members of the HA cluster. If a member is missing at upgrade time, the upgrade will be cancelled. The structure of known_ha_members block is documented below.
    maximum_minutes int
    Maximum number of minutes to allow for immediate upgrade preparation.
    serial str
    Serial number of the node to include.
    setup_time str
    Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC).
    status str
    Current status of the upgrade. Valid values: disabled, initialized, downloading, device-disconnected, ready, coordinating, staging, final-check, upgrade-devices, cancelled, confirmed, done, failed.
    time str
    Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
    timing str
    Run immediately or at a scheduled time. Valid values: immediate, scheduled.
    upgrade_path str
    Fortinet OS image versions to upgrade through in major-minor-patch format, such as 7-0-4.
    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.
    deviceType String
    Fortinet device type.
    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 ].
    failureReason String
    Upgrade failure reason.
    getAllTables 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.
    haRebootController String
    Serial number of the FortiGate unit that will control the reboot process for the federated upgrade of the HA cluster.
    knownHaMembers List<Property Map>
    Known members of the HA cluster. If a member is missing at upgrade time, the upgrade will be cancelled. The structure of known_ha_members block is documented below.
    maximumMinutes Number
    Maximum number of minutes to allow for immediate upgrade preparation.
    serial String
    Serial number of the node to include.
    setupTime String
    Upgrade preparation start time in UTC (hh:mm yyyy/mm/dd UTC).
    status String
    Current status of the upgrade. Valid values: disabled, initialized, downloading, device-disconnected, ready, coordinating, staging, final-check, upgrade-devices, cancelled, confirmed, done, failed.
    time String
    Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
    timing String
    Run immediately or at a scheduled time. Valid values: immediate, scheduled.
    upgradePath String
    Fortinet OS image versions to upgrade through in major-minor-patch format, such as 7-0-4.
    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

    DeviceupgradeKnownHaMember, DeviceupgradeKnownHaMemberArgs

    Serial string
    Serial number of HA member
    Serial string
    Serial number of HA member
    serial String
    Serial number of HA member
    serial string
    Serial number of HA member
    serial str
    Serial number of HA member
    serial String
    Serial number of HA member

    Import

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

    $ pulumi import fortios:system/deviceupgrade:Deviceupgrade labelname {{serial}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/deviceupgrade:Deviceupgrade labelname {{serial}}

    $ 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.6 published on Tuesday, Jul 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios