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

fortios.wanopt.Peer

Explore with Pulumi AI

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

    Configure WAN optimization peers.

    Example Usage

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

const trname = new fortios.wanopt.Peer("trname", {
    ip: "1.1.1.1",
    peerHostId: "1",
});

    import pulumi
import pulumiverse_fortios as fortios

trname = fortios.wanopt.Peer("trname",
    ip="1.1.1.1",
    peer_host_id="1")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := wanopt.NewPeer(ctx, "trname", &wanopt.PeerArgs{
			Ip:         pulumi.String("1.1.1.1"),
			PeerHostId: pulumi.String("1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.Wanopt.Peer("trname", new()
    {
        Ip = "1.1.1.1",
        PeerHostId = "1",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.wanopt.Peer;
import com.pulumi.fortios.wanopt.PeerArgs;
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 Peer("trname", PeerArgs.builder()
            .ip("1.1.1.1")
            .peerHostId("1")
            .build());

    }
}

    resources:
  trname:
    type: fortios:wanopt:Peer
    properties:
      ip: 1.1.1.1
      peerHostId: '1'

    Create Peer Resource

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

    Constructor syntax

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

@overload
def Peer(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         ip: Optional[str] = None,
         peer_host_id: Optional[str] = None,
         vdomparam: Optional[str] = None)
    func NewPeer(ctx *Context, name string, args *PeerArgs, opts ...ResourceOption) (*Peer, error)
    public Peer(string name, PeerArgs? args = null, CustomResourceOptions? opts = null)
    public Peer(String name, PeerArgs args)
public Peer(String name, PeerArgs args, CustomResourceOptions options)

    type: fortios:wanopt:Peer
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 PeerArgs
    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 PeerArgs
    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 PeerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PeerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PeerArgs
    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 fortiosPeerResource = new Fortios.Wanopt.Peer("fortiosPeerResource", new()
{
    Ip = "string",
    PeerHostId = "string",
    Vdomparam = "string",
});

    example, err := wanopt.NewPeer(ctx, "fortiosPeerResource", &wanopt.PeerArgs{
	Ip:         pulumi.String("string"),
	PeerHostId: pulumi.String("string"),
	Vdomparam:  pulumi.String("string"),
})

    var fortiosPeerResource = new Peer("fortiosPeerResource", PeerArgs.builder()
    .ip("string")
    .peerHostId("string")
    .vdomparam("string")
    .build());

    fortios_peer_resource = fortios.wanopt.Peer("fortiosPeerResource",
    ip="string",
    peer_host_id="string",
    vdomparam="string")

    const fortiosPeerResource = new fortios.wanopt.Peer("fortiosPeerResource", {
    ip: "string",
    peerHostId: "string",
    vdomparam: "string",
});

    type: fortios:wanopt:Peer
properties:
    ip: string
    peerHostId: string
    vdomparam: string

    Peer Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Peer resource accepts the following input properties:

    Ip string
    Peer IP address.
    PeerHostId string
    Peer host ID.
    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.
    Ip string
    Peer IP address.
    PeerHostId string
    Peer host ID.
    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.
    ip String
    Peer IP address.
    peerHostId String
    Peer host ID.
    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.
    ip string
    Peer IP address.
    peerHostId string
    Peer host ID.
    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.
    ip str
    Peer IP address.
    peer_host_id str
    Peer host ID.
    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.
    ip String
    Peer IP address.
    peerHostId String
    Peer host ID.
    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 Peer 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 Peer Resource

    Get an existing Peer 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?: PeerState, opts?: CustomResourceOptions): Peer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ip: Optional[str] = None,
        peer_host_id: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Peer
    func GetPeer(ctx *Context, name string, id IDInput, state *PeerState, opts ...ResourceOption) (*Peer, error)
    public static Peer Get(string name, Input<string> id, PeerState? state, CustomResourceOptions? opts = null)
    public static Peer get(String name, Output<String> id, PeerState 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:
    Ip string
    Peer IP address.
    PeerHostId string
    Peer host ID.
    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.
    Ip string
    Peer IP address.
    PeerHostId string
    Peer host ID.
    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.
    ip String
    Peer IP address.
    peerHostId String
    Peer host ID.
    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.
    ip string
    Peer IP address.
    peerHostId string
    Peer host ID.
    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.
    ip str
    Peer IP address.
    peer_host_id str
    Peer host ID.
    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.
    ip String
    Peer IP address.
    peerHostId String
    Peer host ID.
    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.

    Import

    Wanopt Peer can be imported using any of these accepted formats:

    $ pulumi import fortios:wanopt/peer:Peer labelname {{peer_host_id}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:wanopt/peer:Peer labelname {{peer_host_id}}

    $ 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