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

fortios.endpointcontrol.Forticlientregistrationsync

Explore with Pulumi AI

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

Configure FortiClient registration synchronization settings. Applies to FortiOS Version <= 6.2.0.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";

const trname = new fortios.endpointcontrol.Forticlientregistrationsync("trname", {
    peerIp: "1.1.1.1",
    peerName: "1",
});
Copy
import pulumi
import pulumiverse_fortios as fortios

trname = fortios.endpointcontrol.Forticlientregistrationsync("trname",
    peer_ip="1.1.1.1",
    peer_name="1")
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/endpointcontrol"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := endpointcontrol.NewForticlientregistrationsync(ctx, "trname", &endpointcontrol.ForticlientregistrationsyncArgs{
			PeerIp:   pulumi.String("1.1.1.1"),
			PeerName: pulumi.String("1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.Endpointcontrol.Forticlientregistrationsync("trname", new()
    {
        PeerIp = "1.1.1.1",
        PeerName = "1",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.endpointcontrol.Forticlientregistrationsync;
import com.pulumi.fortios.endpointcontrol.ForticlientregistrationsyncArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var trname = new Forticlientregistrationsync("trname", ForticlientregistrationsyncArgs.builder()
            .peerIp("1.1.1.1")
            .peerName("1")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortios:endpointcontrol:Forticlientregistrationsync
    properties:
      peerIp: 1.1.1.1
      peerName: '1'
Copy

Create Forticlientregistrationsync Resource

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

Constructor syntax

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

@overload
def Forticlientregistrationsync(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                peer_ip: Optional[str] = None,
                                peer_name: Optional[str] = None,
                                vdomparam: Optional[str] = None)
func NewForticlientregistrationsync(ctx *Context, name string, args ForticlientregistrationsyncArgs, opts ...ResourceOption) (*Forticlientregistrationsync, error)
public Forticlientregistrationsync(string name, ForticlientregistrationsyncArgs args, CustomResourceOptions? opts = null)
public Forticlientregistrationsync(String name, ForticlientregistrationsyncArgs args)
public Forticlientregistrationsync(String name, ForticlientregistrationsyncArgs args, CustomResourceOptions options)

type: fortios:endpointcontrol:Forticlientregistrationsync
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 This property is required. ForticlientregistrationsyncArgs
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 This property is required. ForticlientregistrationsyncArgs
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 This property is required. ForticlientregistrationsyncArgs
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 This property is required. ForticlientregistrationsyncArgs
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. ForticlientregistrationsyncArgs
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 forticlientregistrationsyncResource = new Fortios.Endpointcontrol.Forticlientregistrationsync("forticlientregistrationsyncResource", new()
{
    PeerIp = "string",
    PeerName = "string",
    Vdomparam = "string",
});
Copy
example, err := endpointcontrol.NewForticlientregistrationsync(ctx, "forticlientregistrationsyncResource", &endpointcontrol.ForticlientregistrationsyncArgs{
	PeerIp:    pulumi.String("string"),
	PeerName:  pulumi.String("string"),
	Vdomparam: pulumi.String("string"),
})
Copy
var forticlientregistrationsyncResource = new Forticlientregistrationsync("forticlientregistrationsyncResource", ForticlientregistrationsyncArgs.builder()
    .peerIp("string")
    .peerName("string")
    .vdomparam("string")
    .build());
Copy
forticlientregistrationsync_resource = fortios.endpointcontrol.Forticlientregistrationsync("forticlientregistrationsyncResource",
    peer_ip="string",
    peer_name="string",
    vdomparam="string")
Copy
const forticlientregistrationsyncResource = new fortios.endpointcontrol.Forticlientregistrationsync("forticlientregistrationsyncResource", {
    peerIp: "string",
    peerName: "string",
    vdomparam: "string",
});
Copy
type: fortios:endpointcontrol:Forticlientregistrationsync
properties:
    peerIp: string
    peerName: string
    vdomparam: string
Copy

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

PeerIp This property is required. string
IP address of the peer FortiGate for endpoint license synchronization.
PeerName Changes to this property will trigger replacement. string
Peer name.
Vdomparam Changes to this property will trigger replacement. 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.
PeerIp This property is required. string
IP address of the peer FortiGate for endpoint license synchronization.
PeerName Changes to this property will trigger replacement. string
Peer name.
Vdomparam Changes to this property will trigger replacement. 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.
peerIp This property is required. String
IP address of the peer FortiGate for endpoint license synchronization.
peerName Changes to this property will trigger replacement. String
Peer name.
vdomparam Changes to this property will trigger replacement. 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.
peerIp This property is required. string
IP address of the peer FortiGate for endpoint license synchronization.
peerName Changes to this property will trigger replacement. string
Peer name.
vdomparam Changes to this property will trigger replacement. 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.
peer_ip This property is required. str
IP address of the peer FortiGate for endpoint license synchronization.
peer_name Changes to this property will trigger replacement. str
Peer name.
vdomparam Changes to this property will trigger replacement. 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.
peerIp This property is required. String
IP address of the peer FortiGate for endpoint license synchronization.
peerName Changes to this property will trigger replacement. String
Peer name.
vdomparam Changes to this property will trigger replacement. 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 Forticlientregistrationsync 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 Forticlientregistrationsync Resource

Get an existing Forticlientregistrationsync 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?: ForticlientregistrationsyncState, opts?: CustomResourceOptions): Forticlientregistrationsync
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        peer_ip: Optional[str] = None,
        peer_name: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Forticlientregistrationsync
func GetForticlientregistrationsync(ctx *Context, name string, id IDInput, state *ForticlientregistrationsyncState, opts ...ResourceOption) (*Forticlientregistrationsync, error)
public static Forticlientregistrationsync Get(string name, Input<string> id, ForticlientregistrationsyncState? state, CustomResourceOptions? opts = null)
public static Forticlientregistrationsync get(String name, Output<String> id, ForticlientregistrationsyncState state, CustomResourceOptions options)
resources:  _:    type: fortios:endpointcontrol:Forticlientregistrationsync    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:
PeerIp string
IP address of the peer FortiGate for endpoint license synchronization.
PeerName Changes to this property will trigger replacement. string
Peer name.
Vdomparam Changes to this property will trigger replacement. 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.
PeerIp string
IP address of the peer FortiGate for endpoint license synchronization.
PeerName Changes to this property will trigger replacement. string
Peer name.
Vdomparam Changes to this property will trigger replacement. 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.
peerIp String
IP address of the peer FortiGate for endpoint license synchronization.
peerName Changes to this property will trigger replacement. String
Peer name.
vdomparam Changes to this property will trigger replacement. 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.
peerIp string
IP address of the peer FortiGate for endpoint license synchronization.
peerName Changes to this property will trigger replacement. string
Peer name.
vdomparam Changes to this property will trigger replacement. 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.
peer_ip str
IP address of the peer FortiGate for endpoint license synchronization.
peer_name Changes to this property will trigger replacement. str
Peer name.
vdomparam Changes to this property will trigger replacement. 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.
peerIp String
IP address of the peer FortiGate for endpoint license synchronization.
peerName Changes to this property will trigger replacement. String
Peer name.
vdomparam Changes to this property will trigger replacement. 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.

Import

EndpointControl ForticlientRegistrationSync can be imported using any of these accepted formats:

$ pulumi import fortios:endpointcontrol/forticlientregistrationsync:Forticlientregistrationsync labelname {{peer_name}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:endpointcontrol/forticlientregistrationsync:Forticlientregistrationsync labelname {{peer_name}}
Copy

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