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

fortios.system.Federatedupgrade

Explore with Pulumi AI

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

    Coordinate federated upgrades within the Security Fabric. Applies to FortiOS Version >= 7.0.0.

    Create Federatedupgrade Resource

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

    Constructor syntax

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

@overload
def Federatedupgrade(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     dynamic_sort_subtable: Optional[str] = None,
                     failure_device: 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[FederatedupgradeKnownHaMemberArgs]] = None,
                     next_path_index: Optional[int] = None,
                     node_lists: Optional[Sequence[FederatedupgradeNodeListArgs]] = None,
                     status: Optional[str] = None,
                     upgrade_id: Optional[int] = None,
                     vdomparam: Optional[str] = None)
    func NewFederatedupgrade(ctx *Context, name string, args *FederatedupgradeArgs, opts ...ResourceOption) (*Federatedupgrade, error)
    public Federatedupgrade(string name, FederatedupgradeArgs? args = null, CustomResourceOptions? opts = null)
    public Federatedupgrade(String name, FederatedupgradeArgs args)
public Federatedupgrade(String name, FederatedupgradeArgs args, CustomResourceOptions options)

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

    example, err := system.NewFederatedupgrade(ctx, "federatedupgradeResource", &system.FederatedupgradeArgs{
	DynamicSortSubtable: pulumi.String("string"),
	FailureDevice:       pulumi.String("string"),
	FailureReason:       pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	HaRebootController:  pulumi.String("string"),
	KnownHaMembers: system.FederatedupgradeKnownHaMemberArray{
		&system.FederatedupgradeKnownHaMemberArgs{
			Serial: pulumi.String("string"),
		},
	},
	NextPathIndex: pulumi.Int(0),
	NodeLists: system.FederatedupgradeNodeListArray{
		&system.FederatedupgradeNodeListArgs{
			CoordinatingFortigate: pulumi.String("string"),
			DeviceType:            pulumi.String("string"),
			MaximumMinutes:        pulumi.Int(0),
			Serial:                pulumi.String("string"),
			SetupTime:             pulumi.String("string"),
			Time:                  pulumi.String("string"),
			Timing:                pulumi.String("string"),
			UpgradePath:           pulumi.String("string"),
		},
	},
	Status:    pulumi.String("string"),
	UpgradeId: pulumi.Int(0),
	Vdomparam: pulumi.String("string"),
})

    var federatedupgradeResource = new Federatedupgrade("federatedupgradeResource", FederatedupgradeArgs.builder()
    .dynamicSortSubtable("string")
    .failureDevice("string")
    .failureReason("string")
    .getAllTables("string")
    .haRebootController("string")
    .knownHaMembers(FederatedupgradeKnownHaMemberArgs.builder()
        .serial("string")
        .build())
    .nextPathIndex(0)
    .nodeLists(FederatedupgradeNodeListArgs.builder()
        .coordinatingFortigate("string")
        .deviceType("string")
        .maximumMinutes(0)
        .serial("string")
        .setupTime("string")
        .time("string")
        .timing("string")
        .upgradePath("string")
        .build())
    .status("string")
    .upgradeId(0)
    .vdomparam("string")
    .build());

    federatedupgrade_resource = fortios.system.Federatedupgrade("federatedupgradeResource",
    dynamic_sort_subtable="string",
    failure_device="string",
    failure_reason="string",
    get_all_tables="string",
    ha_reboot_controller="string",
    known_ha_members=[{
        "serial": "string",
    }],
    next_path_index=0,
    node_lists=[{
        "coordinating_fortigate": "string",
        "device_type": "string",
        "maximum_minutes": 0,
        "serial": "string",
        "setup_time": "string",
        "time": "string",
        "timing": "string",
        "upgrade_path": "string",
    }],
    status="string",
    upgrade_id=0,
    vdomparam="string")

    const federatedupgradeResource = new fortios.system.Federatedupgrade("federatedupgradeResource", {
    dynamicSortSubtable: "string",
    failureDevice: "string",
    failureReason: "string",
    getAllTables: "string",
    haRebootController: "string",
    knownHaMembers: [{
        serial: "string",
    }],
    nextPathIndex: 0,
    nodeLists: [{
        coordinatingFortigate: "string",
        deviceType: "string",
        maximumMinutes: 0,
        serial: "string",
        setupTime: "string",
        time: "string",
        timing: "string",
        upgradePath: "string",
    }],
    status: "string",
    upgradeId: 0,
    vdomparam: "string",
});

    type: fortios:system:Federatedupgrade
properties:
    dynamicSortSubtable: string
    failureDevice: string
    failureReason: string
    getAllTables: string
    haRebootController: string
    knownHaMembers:
        - serial: string
    nextPathIndex: 0
    nodeLists:
        - coordinatingFortigate: string
          deviceType: string
          maximumMinutes: 0
          serial: string
          setupTime: string
          time: string
          timing: string
          upgradePath: string
    status: string
    upgradeId: 0
    vdomparam: string

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

    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 ].
    FailureDevice string
    Serial number of the node to include.
    FailureReason string
    Reason for upgrade failure.
    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.FederatedupgradeKnownHaMember>
    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.
    NextPathIndex int
    The index of the next image to upgrade to.
    NodeLists List<Pulumiverse.Fortios.System.Inputs.FederatedupgradeNodeList>
    Nodes which will be included in the upgrade. The structure of node_list block is documented below.
    Status string
    Current status of the upgrade.
    UpgradeId int
    Unique identifier for this upgrade.
    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.
    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 ].
    FailureDevice string
    Serial number of the node to include.
    FailureReason string
    Reason for upgrade failure.
    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 []FederatedupgradeKnownHaMemberArgs
    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.
    NextPathIndex int
    The index of the next image to upgrade to.
    NodeLists []FederatedupgradeNodeListArgs
    Nodes which will be included in the upgrade. The structure of node_list block is documented below.
    Status string
    Current status of the upgrade.
    UpgradeId int
    Unique identifier for this upgrade.
    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.
    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 ].
    failureDevice String
    Serial number of the node to include.
    failureReason String
    Reason for upgrade failure.
    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<FederatedupgradeKnownHaMember>
    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.
    nextPathIndex Integer
    The index of the next image to upgrade to.
    nodeLists List<FederatedupgradeNodeList>
    Nodes which will be included in the upgrade. The structure of node_list block is documented below.
    status String
    Current status of the upgrade.
    upgradeId Integer
    Unique identifier for this upgrade.
    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.
    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 ].
    failureDevice string
    Serial number of the node to include.
    failureReason string
    Reason for upgrade failure.
    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 FederatedupgradeKnownHaMember[]
    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.
    nextPathIndex number
    The index of the next image to upgrade to.
    nodeLists FederatedupgradeNodeList[]
    Nodes which will be included in the upgrade. The structure of node_list block is documented below.
    status string
    Current status of the upgrade.
    upgradeId number
    Unique identifier for this upgrade.
    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.
    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_device str
    Serial number of the node to include.
    failure_reason str
    Reason for upgrade failure.
    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[FederatedupgradeKnownHaMemberArgs]
    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.
    next_path_index int
    The index of the next image to upgrade to.
    node_lists Sequence[FederatedupgradeNodeListArgs]
    Nodes which will be included in the upgrade. The structure of node_list block is documented below.
    status str
    Current status of the upgrade.
    upgrade_id int
    Unique identifier for this upgrade.
    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.
    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 ].
    failureDevice String
    Serial number of the node to include.
    failureReason String
    Reason for upgrade failure.
    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.
    nextPathIndex Number
    The index of the next image to upgrade to.
    nodeLists List<Property Map>
    Nodes which will be included in the upgrade. The structure of node_list block is documented below.
    status String
    Current status of the upgrade.
    upgradeId Number
    Unique identifier for this upgrade.
    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 Federatedupgrade 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 Federatedupgrade Resource

    Get an existing Federatedupgrade 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?: FederatedupgradeState, opts?: CustomResourceOptions): Federatedupgrade
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dynamic_sort_subtable: Optional[str] = None,
        failure_device: 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[FederatedupgradeKnownHaMemberArgs]] = None,
        next_path_index: Optional[int] = None,
        node_lists: Optional[Sequence[FederatedupgradeNodeListArgs]] = None,
        status: Optional[str] = None,
        upgrade_id: Optional[int] = None,
        vdomparam: Optional[str] = None) -> Federatedupgrade
    func GetFederatedupgrade(ctx *Context, name string, id IDInput, state *FederatedupgradeState, opts ...ResourceOption) (*Federatedupgrade, error)
    public static Federatedupgrade Get(string name, Input<string> id, FederatedupgradeState? state, CustomResourceOptions? opts = null)
    public static Federatedupgrade get(String name, Output<String> id, FederatedupgradeState state, CustomResourceOptions options)
    resources:  _:    type: fortios:system:Federatedupgrade    get:      id: ${id}
    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:
    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 ].
    FailureDevice string
    Serial number of the node to include.
    FailureReason string
    Reason for upgrade failure.
    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.FederatedupgradeKnownHaMember>
    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.
    NextPathIndex int
    The index of the next image to upgrade to.
    NodeLists List<Pulumiverse.Fortios.System.Inputs.FederatedupgradeNodeList>
    Nodes which will be included in the upgrade. The structure of node_list block is documented below.
    Status string
    Current status of the upgrade.
    UpgradeId int
    Unique identifier for this upgrade.
    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.
    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 ].
    FailureDevice string
    Serial number of the node to include.
    FailureReason string
    Reason for upgrade failure.
    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 []FederatedupgradeKnownHaMemberArgs
    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.
    NextPathIndex int
    The index of the next image to upgrade to.
    NodeLists []FederatedupgradeNodeListArgs
    Nodes which will be included in the upgrade. The structure of node_list block is documented below.
    Status string
    Current status of the upgrade.
    UpgradeId int
    Unique identifier for this upgrade.
    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.
    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 ].
    failureDevice String
    Serial number of the node to include.
    failureReason String
    Reason for upgrade failure.
    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<FederatedupgradeKnownHaMember>
    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.
    nextPathIndex Integer
    The index of the next image to upgrade to.
    nodeLists List<FederatedupgradeNodeList>
    Nodes which will be included in the upgrade. The structure of node_list block is documented below.
    status String
    Current status of the upgrade.
    upgradeId Integer
    Unique identifier for this upgrade.
    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.
    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 ].
    failureDevice string
    Serial number of the node to include.
    failureReason string
    Reason for upgrade failure.
    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 FederatedupgradeKnownHaMember[]
    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.
    nextPathIndex number
    The index of the next image to upgrade to.
    nodeLists FederatedupgradeNodeList[]
    Nodes which will be included in the upgrade. The structure of node_list block is documented below.
    status string
    Current status of the upgrade.
    upgradeId number
    Unique identifier for this upgrade.
    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.
    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_device str
    Serial number of the node to include.
    failure_reason str
    Reason for upgrade failure.
    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[FederatedupgradeKnownHaMemberArgs]
    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.
    next_path_index int
    The index of the next image to upgrade to.
    node_lists Sequence[FederatedupgradeNodeListArgs]
    Nodes which will be included in the upgrade. The structure of node_list block is documented below.
    status str
    Current status of the upgrade.
    upgrade_id int
    Unique identifier for this upgrade.
    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.
    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 ].
    failureDevice String
    Serial number of the node to include.
    failureReason String
    Reason for upgrade failure.
    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.
    nextPathIndex Number
    The index of the next image to upgrade to.
    nodeLists List<Property Map>
    Nodes which will be included in the upgrade. The structure of node_list block is documented below.
    status String
    Current status of the upgrade.
    upgradeId Number
    Unique identifier for this upgrade.
    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

    FederatedupgradeKnownHaMember, FederatedupgradeKnownHaMemberArgs

    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

    FederatedupgradeNodeList, FederatedupgradeNodeListArgs

    CoordinatingFortigate string
    The serial of the FortiGate that controls this device
    DeviceType string
    What type of device this node represents.
    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).
    Time string
    Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
    Timing string
    Whether the upgrade should be run immediately, or at a scheduled time. Valid values: immediate, scheduled.
    UpgradePath string
    Image IDs to upgrade through.
    CoordinatingFortigate string
    The serial of the FortiGate that controls this device
    DeviceType string
    What type of device this node represents.
    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).
    Time string
    Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
    Timing string
    Whether the upgrade should be run immediately, or at a scheduled time. Valid values: immediate, scheduled.
    UpgradePath string
    Image IDs to upgrade through.
    coordinatingFortigate String
    The serial of the FortiGate that controls this device
    deviceType String
    What type of device this node represents.
    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).
    time String
    Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
    timing String
    Whether the upgrade should be run immediately, or at a scheduled time. Valid values: immediate, scheduled.
    upgradePath String
    Image IDs to upgrade through.
    coordinatingFortigate string
    The serial of the FortiGate that controls this device
    deviceType string
    What type of device this node represents.
    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).
    time string
    Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
    timing string
    Whether the upgrade should be run immediately, or at a scheduled time. Valid values: immediate, scheduled.
    upgradePath string
    Image IDs to upgrade through.
    coordinating_fortigate str
    The serial of the FortiGate that controls this device
    device_type str
    What type of device this node represents.
    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).
    time str
    Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
    timing str
    Whether the upgrade should be run immediately, or at a scheduled time. Valid values: immediate, scheduled.
    upgrade_path str
    Image IDs to upgrade through.
    coordinatingFortigate String
    The serial of the FortiGate that controls this device
    deviceType String
    What type of device this node represents.
    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).
    time String
    Scheduled upgrade execution time in UTC (hh:mm yyyy/mm/dd UTC).
    timing String
    Whether the upgrade should be run immediately, or at a scheduled time. Valid values: immediate, scheduled.
    upgradePath String
    Image IDs to upgrade through.

    Import

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

    $ pulumi import fortios:system/federatedupgrade:Federatedupgrade labelname SystemFederatedUpgrade

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/federatedupgrade:Federatedupgrade labelname SystemFederatedUpgrade

    $ 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