1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. SystemFmgclusterPeer
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev

fortimanager.SystemFmgclusterPeer

Explore with Pulumi AI

Peer.

This resource is a sub resource for variable peer of resource fortimanager.SystemFmgcluster. Conflict and overwrite may occur if use both of them.

Create SystemFmgclusterPeer Resource

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

Constructor syntax

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

@overload
def SystemFmgclusterPeer(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         addr: Optional[str] = None,
                         fqdn: Optional[str] = None,
                         name: Optional[str] = None,
                         sn: Optional[str] = None,
                         system_fmgcluster_peer_id: Optional[str] = None)
func NewSystemFmgclusterPeer(ctx *Context, name string, args *SystemFmgclusterPeerArgs, opts ...ResourceOption) (*SystemFmgclusterPeer, error)
public SystemFmgclusterPeer(string name, SystemFmgclusterPeerArgs? args = null, CustomResourceOptions? opts = null)
public SystemFmgclusterPeer(String name, SystemFmgclusterPeerArgs args)
public SystemFmgclusterPeer(String name, SystemFmgclusterPeerArgs args, CustomResourceOptions options)
type: fortimanager:SystemFmgclusterPeer
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 SystemFmgclusterPeerArgs
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 SystemFmgclusterPeerInitArgs
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 SystemFmgclusterPeerArgs
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 SystemFmgclusterPeerArgs
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. SystemFmgclusterPeerArgs
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 systemFmgclusterPeerResource = new Fortimanager.SystemFmgclusterPeer("systemFmgclusterPeerResource", new()
{
    Addr = "string",
    Fqdn = "string",
    Name = "string",
    Sn = "string",
    SystemFmgclusterPeerId = "string",
});
Copy
example, err := fortimanager.NewSystemFmgclusterPeer(ctx, "systemFmgclusterPeerResource", &fortimanager.SystemFmgclusterPeerArgs{
	Addr:                   pulumi.String("string"),
	Fqdn:                   pulumi.String("string"),
	Name:                   pulumi.String("string"),
	Sn:                     pulumi.String("string"),
	SystemFmgclusterPeerId: pulumi.String("string"),
})
Copy
var systemFmgclusterPeerResource = new SystemFmgclusterPeer("systemFmgclusterPeerResource", SystemFmgclusterPeerArgs.builder()
    .addr("string")
    .fqdn("string")
    .name("string")
    .sn("string")
    .systemFmgclusterPeerId("string")
    .build());
Copy
system_fmgcluster_peer_resource = fortimanager.SystemFmgclusterPeer("systemFmgclusterPeerResource",
    addr="string",
    fqdn="string",
    name="string",
    sn="string",
    system_fmgcluster_peer_id="string")
Copy
const systemFmgclusterPeerResource = new fortimanager.SystemFmgclusterPeer("systemFmgclusterPeerResource", {
    addr: "string",
    fqdn: "string",
    name: "string",
    sn: "string",
    systemFmgclusterPeerId: "string",
});
Copy
type: fortimanager:SystemFmgclusterPeer
properties:
    addr: string
    fqdn: string
    name: string
    sn: string
    systemFmgclusterPeerId: string
Copy

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

Addr string
Address of peer.
Fqdn string
FQDN of peer.
Name string
Name of peer.
Sn string
Serial number of peer.
SystemFmgclusterPeerId string
an identifier for the resource with format {{sn}}.
Addr string
Address of peer.
Fqdn string
FQDN of peer.
Name string
Name of peer.
Sn string
Serial number of peer.
SystemFmgclusterPeerId string
an identifier for the resource with format {{sn}}.
addr String
Address of peer.
fqdn String
FQDN of peer.
name String
Name of peer.
sn String
Serial number of peer.
systemFmgclusterPeerId String
an identifier for the resource with format {{sn}}.
addr string
Address of peer.
fqdn string
FQDN of peer.
name string
Name of peer.
sn string
Serial number of peer.
systemFmgclusterPeerId string
an identifier for the resource with format {{sn}}.
addr str
Address of peer.
fqdn str
FQDN of peer.
name str
Name of peer.
sn str
Serial number of peer.
system_fmgcluster_peer_id str
an identifier for the resource with format {{sn}}.
addr String
Address of peer.
fqdn String
FQDN of peer.
name String
Name of peer.
sn String
Serial number of peer.
systemFmgclusterPeerId String
an identifier for the resource with format {{sn}}.

Outputs

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

Get an existing SystemFmgclusterPeer 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?: SystemFmgclusterPeerState, opts?: CustomResourceOptions): SystemFmgclusterPeer
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        addr: Optional[str] = None,
        fqdn: Optional[str] = None,
        name: Optional[str] = None,
        sn: Optional[str] = None,
        system_fmgcluster_peer_id: Optional[str] = None) -> SystemFmgclusterPeer
func GetSystemFmgclusterPeer(ctx *Context, name string, id IDInput, state *SystemFmgclusterPeerState, opts ...ResourceOption) (*SystemFmgclusterPeer, error)
public static SystemFmgclusterPeer Get(string name, Input<string> id, SystemFmgclusterPeerState? state, CustomResourceOptions? opts = null)
public static SystemFmgclusterPeer get(String name, Output<String> id, SystemFmgclusterPeerState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:SystemFmgclusterPeer    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:
Addr string
Address of peer.
Fqdn string
FQDN of peer.
Name string
Name of peer.
Sn string
Serial number of peer.
SystemFmgclusterPeerId string
an identifier for the resource with format {{sn}}.
Addr string
Address of peer.
Fqdn string
FQDN of peer.
Name string
Name of peer.
Sn string
Serial number of peer.
SystemFmgclusterPeerId string
an identifier for the resource with format {{sn}}.
addr String
Address of peer.
fqdn String
FQDN of peer.
name String
Name of peer.
sn String
Serial number of peer.
systemFmgclusterPeerId String
an identifier for the resource with format {{sn}}.
addr string
Address of peer.
fqdn string
FQDN of peer.
name string
Name of peer.
sn string
Serial number of peer.
systemFmgclusterPeerId string
an identifier for the resource with format {{sn}}.
addr str
Address of peer.
fqdn str
FQDN of peer.
name str
Name of peer.
sn str
Serial number of peer.
system_fmgcluster_peer_id str
an identifier for the resource with format {{sn}}.
addr String
Address of peer.
fqdn String
FQDN of peer.
name String
Name of peer.
sn String
Serial number of peer.
systemFmgclusterPeerId String
an identifier for the resource with format {{sn}}.

Import

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

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/systemFmgclusterPeer:SystemFmgclusterPeer labelname {{sn}}
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.