1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. SystemFmgcluster
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev

fortimanager.SystemFmgcluster

Explore with Pulumi AI

fmg clsuter.

The following variables have sub resource. Avoid using them together, otherwise conflicts and overwrites may occur.

  • peer: fortimanager.SystemFmgclusterPeer

Create SystemFmgcluster Resource

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

Constructor syntax

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

@overload
def SystemFmgcluster(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     dynamic_sort_subtable: Optional[str] = None,
                     fqdn: Optional[str] = None,
                     ip: Optional[str] = None,
                     mode: Optional[str] = None,
                     peers: Optional[Sequence[SystemFmgclusterPeerArgs]] = None,
                     system_fmgcluster_id: Optional[str] = None)
func NewSystemFmgcluster(ctx *Context, name string, args *SystemFmgclusterArgs, opts ...ResourceOption) (*SystemFmgcluster, error)
public SystemFmgcluster(string name, SystemFmgclusterArgs? args = null, CustomResourceOptions? opts = null)
public SystemFmgcluster(String name, SystemFmgclusterArgs args)
public SystemFmgcluster(String name, SystemFmgclusterArgs args, CustomResourceOptions options)
type: fortimanager:SystemFmgcluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args SystemFmgclusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args SystemFmgclusterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args SystemFmgclusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args SystemFmgclusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SystemFmgclusterArgs
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 systemFmgclusterResource = new Fortimanager.SystemFmgcluster("systemFmgclusterResource", new()
{
    DynamicSortSubtable = "string",
    Fqdn = "string",
    Ip = "string",
    Mode = "string",
    Peers = new[]
    {
        new Fortimanager.Inputs.SystemFmgclusterPeerArgs
        {
            Addr = "string",
            Fqdn = "string",
            Name = "string",
            Sn = "string",
        },
    },
    SystemFmgclusterId = "string",
});
Copy
example, err := fortimanager.NewSystemFmgcluster(ctx, "systemFmgclusterResource", &fortimanager.SystemFmgclusterArgs{
DynamicSortSubtable: pulumi.String("string"),
Fqdn: pulumi.String("string"),
Ip: pulumi.String("string"),
Mode: pulumi.String("string"),
Peers: .SystemFmgclusterPeerTypeArray{
&.SystemFmgclusterPeerTypeArgs{
Addr: pulumi.String("string"),
Fqdn: pulumi.String("string"),
Name: pulumi.String("string"),
Sn: pulumi.String("string"),
},
},
SystemFmgclusterId: pulumi.String("string"),
})
Copy
var systemFmgclusterResource = new SystemFmgcluster("systemFmgclusterResource", SystemFmgclusterArgs.builder()
    .dynamicSortSubtable("string")
    .fqdn("string")
    .ip("string")
    .mode("string")
    .peers(SystemFmgclusterPeerArgs.builder()
        .addr("string")
        .fqdn("string")
        .name("string")
        .sn("string")
        .build())
    .systemFmgclusterId("string")
    .build());
Copy
system_fmgcluster_resource = fortimanager.SystemFmgcluster("systemFmgclusterResource",
    dynamic_sort_subtable="string",
    fqdn="string",
    ip="string",
    mode="string",
    peers=[{
        "addr": "string",
        "fqdn": "string",
        "name": "string",
        "sn": "string",
    }],
    system_fmgcluster_id="string")
Copy
const systemFmgclusterResource = new fortimanager.SystemFmgcluster("systemFmgclusterResource", {
    dynamicSortSubtable: "string",
    fqdn: "string",
    ip: "string",
    mode: "string",
    peers: [{
        addr: "string",
        fqdn: "string",
        name: "string",
        sn: "string",
    }],
    systemFmgclusterId: "string",
});
Copy
type: fortimanager:SystemFmgcluster
properties:
    dynamicSortSubtable: string
    fqdn: string
    ip: string
    mode: string
    peers:
        - addr: string
          fqdn: string
          name: string
          sn: string
    systemFmgclusterId: string
Copy

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

DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Fqdn string
Local fqdn.
Ip string
Local address.
Mode string
Mode. standalone - Standalone. primary - Primary. worker - Worker. Valid values: standalone, primary, worker.
Peers List<SystemFmgclusterPeer>
Peer. The structure of peer block is documented below.
SystemFmgclusterId string
an identifier for the resource.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Fqdn string
Local fqdn.
Ip string
Local address.
Mode string
Mode. standalone - Standalone. primary - Primary. worker - Worker. Valid values: standalone, primary, worker.
Peers []SystemFmgclusterPeerTypeArgs
Peer. The structure of peer block is documented below.
SystemFmgclusterId string
an identifier for the resource.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
fqdn String
Local fqdn.
ip String
Local address.
mode String
Mode. standalone - Standalone. primary - Primary. worker - Worker. Valid values: standalone, primary, worker.
peers List<SystemFmgclusterPeer>
Peer. The structure of peer block is documented below.
systemFmgclusterId String
an identifier for the resource.
dynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
fqdn string
Local fqdn.
ip string
Local address.
mode string
Mode. standalone - Standalone. primary - Primary. worker - Worker. Valid values: standalone, primary, worker.
peers SystemFmgclusterPeer[]
Peer. The structure of peer block is documented below.
systemFmgclusterId string
an identifier for the resource.
dynamic_sort_subtable str
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
fqdn str
Local fqdn.
ip str
Local address.
mode str
Mode. standalone - Standalone. primary - Primary. worker - Worker. Valid values: standalone, primary, worker.
peers Sequence[SystemFmgclusterPeerArgs]
Peer. The structure of peer block is documented below.
system_fmgcluster_id str
an identifier for the resource.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
fqdn String
Local fqdn.
ip String
Local address.
mode String
Mode. standalone - Standalone. primary - Primary. worker - Worker. Valid values: standalone, primary, worker.
peers List<Property Map>
Peer. The structure of peer block is documented below.
systemFmgclusterId String
an identifier for the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the SystemFmgcluster 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 SystemFmgcluster Resource

Get an existing SystemFmgcluster 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?: SystemFmgclusterState, opts?: CustomResourceOptions): SystemFmgcluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dynamic_sort_subtable: Optional[str] = None,
        fqdn: Optional[str] = None,
        ip: Optional[str] = None,
        mode: Optional[str] = None,
        peers: Optional[Sequence[SystemFmgclusterPeerArgs]] = None,
        system_fmgcluster_id: Optional[str] = None) -> SystemFmgcluster
func GetSystemFmgcluster(ctx *Context, name string, id IDInput, state *SystemFmgclusterState, opts ...ResourceOption) (*SystemFmgcluster, error)
public static SystemFmgcluster Get(string name, Input<string> id, SystemFmgclusterState? state, CustomResourceOptions? opts = null)
public static SystemFmgcluster get(String name, Output<String> id, SystemFmgclusterState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:SystemFmgcluster    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Fqdn string
Local fqdn.
Ip string
Local address.
Mode string
Mode. standalone - Standalone. primary - Primary. worker - Worker. Valid values: standalone, primary, worker.
Peers List<SystemFmgclusterPeer>
Peer. The structure of peer block is documented below.
SystemFmgclusterId string
an identifier for the resource.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Fqdn string
Local fqdn.
Ip string
Local address.
Mode string
Mode. standalone - Standalone. primary - Primary. worker - Worker. Valid values: standalone, primary, worker.
Peers []SystemFmgclusterPeerTypeArgs
Peer. The structure of peer block is documented below.
SystemFmgclusterId string
an identifier for the resource.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
fqdn String
Local fqdn.
ip String
Local address.
mode String
Mode. standalone - Standalone. primary - Primary. worker - Worker. Valid values: standalone, primary, worker.
peers List<SystemFmgclusterPeer>
Peer. The structure of peer block is documented below.
systemFmgclusterId String
an identifier for the resource.
dynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
fqdn string
Local fqdn.
ip string
Local address.
mode string
Mode. standalone - Standalone. primary - Primary. worker - Worker. Valid values: standalone, primary, worker.
peers SystemFmgclusterPeer[]
Peer. The structure of peer block is documented below.
systemFmgclusterId string
an identifier for the resource.
dynamic_sort_subtable str
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
fqdn str
Local fqdn.
ip str
Local address.
mode str
Mode. standalone - Standalone. primary - Primary. worker - Worker. Valid values: standalone, primary, worker.
peers Sequence[SystemFmgclusterPeerArgs]
Peer. The structure of peer block is documented below.
system_fmgcluster_id str
an identifier for the resource.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
fqdn String
Local fqdn.
ip String
Local address.
mode String
Mode. standalone - Standalone. primary - Primary. worker - Worker. Valid values: standalone, primary, worker.
peers List<Property Map>
Peer. The structure of peer block is documented below.
systemFmgclusterId String
an identifier for the resource.

Supporting Types

SystemFmgclusterPeer
, SystemFmgclusterPeerArgs

Addr string
Address of peer.
Fqdn string
FQDN of peer.
Name string
Name of peer.
Sn string
Serial number of peer.
Addr string
Address of peer.
Fqdn string
FQDN of peer.
Name string
Name of peer.
Sn string
Serial number of peer.
addr String
Address of peer.
fqdn String
FQDN of peer.
name String
Name of peer.
sn String
Serial number of peer.
addr string
Address of peer.
fqdn string
FQDN of peer.
name string
Name of peer.
sn string
Serial number of peer.
addr str
Address of peer.
fqdn str
FQDN of peer.
name str
Name of peer.
sn str
Serial number of peer.
addr String
Address of peer.
fqdn String
FQDN of peer.
name String
Name of peer.
sn String
Serial number of peer.

Import

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

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/systemFmgcluster:SystemFmgcluster labelname SystemFmgCluster
Copy

$ unset “FORTIMANAGER_IMPORT_TABLE”

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
fortimanager fortinetdev/terraform-provider-fortimanager
License
Notes
This Pulumi package is based on the fortimanager Terraform Provider.