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

fortios.system.Proxyarp

Explore with Pulumi AI

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

Configure proxy-ARP.

Example Usage

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

const trname = new fortios.system.Proxyarp("trname", {
    endIp: "1.1.1.3",
    fosid: 1,
    "interface": "port4",
    ip: "1.1.1.1",
});
Copy
import pulumi
import pulumiverse_fortios as fortios

trname = fortios.system.Proxyarp("trname",
    end_ip="1.1.1.3",
    fosid=1,
    interface="port4",
    ip="1.1.1.1")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := system.NewProxyarp(ctx, "trname", &system.ProxyarpArgs{
			EndIp:     pulumi.String("1.1.1.3"),
			Fosid:     pulumi.Int(1),
			Interface: pulumi.String("port4"),
			Ip:        pulumi.String("1.1.1.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.System.Proxyarp("trname", new()
    {
        EndIp = "1.1.1.3",
        Fosid = 1,
        Interface = "port4",
        Ip = "1.1.1.1",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.system.Proxyarp;
import com.pulumi.fortios.system.ProxyarpArgs;
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 Proxyarp("trname", ProxyarpArgs.builder()
            .endIp("1.1.1.3")
            .fosid(1)
            .interface_("port4")
            .ip("1.1.1.1")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortios:system:Proxyarp
    properties:
      endIp: 1.1.1.3
      fosid: 1
      interface: port4
      ip: 1.1.1.1
Copy

Create Proxyarp Resource

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

Constructor syntax

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

@overload
def Proxyarp(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             fosid: Optional[int] = None,
             interface: Optional[str] = None,
             ip: Optional[str] = None,
             end_ip: Optional[str] = None,
             vdomparam: Optional[str] = None)
func NewProxyarp(ctx *Context, name string, args ProxyarpArgs, opts ...ResourceOption) (*Proxyarp, error)
public Proxyarp(string name, ProxyarpArgs args, CustomResourceOptions? opts = null)
public Proxyarp(String name, ProxyarpArgs args)
public Proxyarp(String name, ProxyarpArgs args, CustomResourceOptions options)

type: fortios:system:Proxyarp
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. ProxyarpArgs
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. ProxyarpArgs
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. ProxyarpArgs
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. ProxyarpArgs
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. ProxyarpArgs
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 proxyarpResource = new Fortios.System.Proxyarp("proxyarpResource", new()
{
    Fosid = 0,
    Interface = "string",
    Ip = "string",
    EndIp = "string",
    Vdomparam = "string",
});
Copy
example, err := system.NewProxyarp(ctx, "proxyarpResource", &system.ProxyarpArgs{
	Fosid:     pulumi.Int(0),
	Interface: pulumi.String("string"),
	Ip:        pulumi.String("string"),
	EndIp:     pulumi.String("string"),
	Vdomparam: pulumi.String("string"),
})
Copy
var proxyarpResource = new Proxyarp("proxyarpResource", ProxyarpArgs.builder()
    .fosid(0)
    .interface_("string")
    .ip("string")
    .endIp("string")
    .vdomparam("string")
    .build());
Copy
proxyarp_resource = fortios.system.Proxyarp("proxyarpResource",
    fosid=0,
    interface="string",
    ip="string",
    end_ip="string",
    vdomparam="string")
Copy
const proxyarpResource = new fortios.system.Proxyarp("proxyarpResource", {
    fosid: 0,
    "interface": "string",
    ip: "string",
    endIp: "string",
    vdomparam: "string",
});
Copy
type: fortios:system:Proxyarp
properties:
    endIp: string
    fosid: 0
    interface: string
    ip: string
    vdomparam: string
Copy

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

Fosid
This property is required.
Changes to this property will trigger replacement.
int
Unique integer ID of the entry.
Interface This property is required. string
Interface acting proxy-ARP.
Ip This property is required. string
IP address or start IP to be proxied.
EndIp string
End IP of IP range to be proxied.
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.
Fosid
This property is required.
Changes to this property will trigger replacement.
int
Unique integer ID of the entry.
Interface This property is required. string
Interface acting proxy-ARP.
Ip This property is required. string
IP address or start IP to be proxied.
EndIp string
End IP of IP range to be proxied.
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.
fosid
This property is required.
Changes to this property will trigger replacement.
Integer
Unique integer ID of the entry.
interface_ This property is required. String
Interface acting proxy-ARP.
ip This property is required. String
IP address or start IP to be proxied.
endIp String
End IP of IP range to be proxied.
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.
fosid
This property is required.
Changes to this property will trigger replacement.
number
Unique integer ID of the entry.
interface This property is required. string
Interface acting proxy-ARP.
ip This property is required. string
IP address or start IP to be proxied.
endIp string
End IP of IP range to be proxied.
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.
fosid
This property is required.
Changes to this property will trigger replacement.
int
Unique integer ID of the entry.
interface This property is required. str
Interface acting proxy-ARP.
ip This property is required. str
IP address or start IP to be proxied.
end_ip str
End IP of IP range to be proxied.
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.
fosid
This property is required.
Changes to this property will trigger replacement.
Number
Unique integer ID of the entry.
interface This property is required. String
Interface acting proxy-ARP.
ip This property is required. String
IP address or start IP to be proxied.
endIp String
End IP of IP range to be proxied.
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 Proxyarp 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 Proxyarp Resource

Get an existing Proxyarp 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?: ProxyarpState, opts?: CustomResourceOptions): Proxyarp
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        end_ip: Optional[str] = None,
        fosid: Optional[int] = None,
        interface: Optional[str] = None,
        ip: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Proxyarp
func GetProxyarp(ctx *Context, name string, id IDInput, state *ProxyarpState, opts ...ResourceOption) (*Proxyarp, error)
public static Proxyarp Get(string name, Input<string> id, ProxyarpState? state, CustomResourceOptions? opts = null)
public static Proxyarp get(String name, Output<String> id, ProxyarpState state, CustomResourceOptions options)
resources:  _:    type: fortios:system:Proxyarp    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:
EndIp string
End IP of IP range to be proxied.
Fosid Changes to this property will trigger replacement. int
Unique integer ID of the entry.
Interface string
Interface acting proxy-ARP.
Ip string
IP address or start IP to be proxied.
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.
EndIp string
End IP of IP range to be proxied.
Fosid Changes to this property will trigger replacement. int
Unique integer ID of the entry.
Interface string
Interface acting proxy-ARP.
Ip string
IP address or start IP to be proxied.
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.
endIp String
End IP of IP range to be proxied.
fosid Changes to this property will trigger replacement. Integer
Unique integer ID of the entry.
interface_ String
Interface acting proxy-ARP.
ip String
IP address or start IP to be proxied.
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.
endIp string
End IP of IP range to be proxied.
fosid Changes to this property will trigger replacement. number
Unique integer ID of the entry.
interface string
Interface acting proxy-ARP.
ip string
IP address or start IP to be proxied.
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.
end_ip str
End IP of IP range to be proxied.
fosid Changes to this property will trigger replacement. int
Unique integer ID of the entry.
interface str
Interface acting proxy-ARP.
ip str
IP address or start IP to be proxied.
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.
endIp String
End IP of IP range to be proxied.
fosid Changes to this property will trigger replacement. Number
Unique integer ID of the entry.
interface String
Interface acting proxy-ARP.
ip String
IP address or start IP to be proxied.
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

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

$ pulumi import fortios:system/proxyarp:Proxyarp labelname {{fosid}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:system/proxyarp:Proxyarp labelname {{fosid}}
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