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

fortios.system.getVxlan

Explore with Pulumi AI

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

Use this data source to get information on an fortios system vxlan

Using getVxlan

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getVxlan(args: GetVxlanArgs, opts?: InvokeOptions): Promise<GetVxlanResult>
function getVxlanOutput(args: GetVxlanOutputArgs, opts?: InvokeOptions): Output<GetVxlanResult>
Copy
def get_vxlan(name: Optional[str] = None,
              vdomparam: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetVxlanResult
def get_vxlan_output(name: Optional[pulumi.Input[str]] = None,
              vdomparam: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetVxlanResult]
Copy
func LookupVxlan(ctx *Context, args *LookupVxlanArgs, opts ...InvokeOption) (*LookupVxlanResult, error)
func LookupVxlanOutput(ctx *Context, args *LookupVxlanOutputArgs, opts ...InvokeOption) LookupVxlanResultOutput
Copy

> Note: This function is named LookupVxlan in the Go SDK.

public static class GetVxlan 
{
    public static Task<GetVxlanResult> InvokeAsync(GetVxlanArgs args, InvokeOptions? opts = null)
    public static Output<GetVxlanResult> Invoke(GetVxlanInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVxlanResult> getVxlan(GetVxlanArgs args, InvokeOptions options)
public static Output<GetVxlanResult> getVxlan(GetVxlanArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: fortios:system/getVxlan:getVxlan
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Specify the name of the desired system vxlan.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the data source 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.
Name This property is required. string
Specify the name of the desired system vxlan.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the data source 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.
name This property is required. String
Specify the name of the desired system vxlan.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the data source 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.
name This property is required. string
Specify the name of the desired system vxlan.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the data source 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.
name This property is required. str
Specify the name of the desired system vxlan.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the data source 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.
name This property is required. String
Specify the name of the desired system vxlan.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the data source 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.

getVxlan Result

The following output properties are available:

Dstport int
VXLAN destination port (1 - 65535, default = 4789).
EvpnId int
EVPN instance.
Id string
The provider-assigned unique ID for this managed resource.
Interface string
Outgoing interface for VXLAN encapsulated traffic.
IpVersion string
IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast.
LearnFromTraffic string
Enable/disable VXLAN MAC learning from traffic.
MulticastTtl int
VXLAN multicast TTL (1-255, default = 0).
Name string
VXLAN device or interface name. Must be a unique interface name.
RemoteIp6s List<Pulumiverse.Fortios.System.Outputs.GetVxlanRemoteIp6>
IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip6 block is documented below.
RemoteIps List<Pulumiverse.Fortios.System.Outputs.GetVxlanRemoteIp>
IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip block is documented below.
Vni int
VXLAN network ID.
Vdomparam string
Dstport int
VXLAN destination port (1 - 65535, default = 4789).
EvpnId int
EVPN instance.
Id string
The provider-assigned unique ID for this managed resource.
Interface string
Outgoing interface for VXLAN encapsulated traffic.
IpVersion string
IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast.
LearnFromTraffic string
Enable/disable VXLAN MAC learning from traffic.
MulticastTtl int
VXLAN multicast TTL (1-255, default = 0).
Name string
VXLAN device or interface name. Must be a unique interface name.
RemoteIp6s []GetVxlanRemoteIp6
IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip6 block is documented below.
RemoteIps []GetVxlanRemoteIp
IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip block is documented below.
Vni int
VXLAN network ID.
Vdomparam string
dstport Integer
VXLAN destination port (1 - 65535, default = 4789).
evpnId Integer
EVPN instance.
id String
The provider-assigned unique ID for this managed resource.
interface_ String
Outgoing interface for VXLAN encapsulated traffic.
ipVersion String
IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast.
learnFromTraffic String
Enable/disable VXLAN MAC learning from traffic.
multicastTtl Integer
VXLAN multicast TTL (1-255, default = 0).
name String
VXLAN device or interface name. Must be a unique interface name.
remoteIp6s List<GetVxlanRemoteIp6>
IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip6 block is documented below.
remoteIps List<GetVxlanRemoteIp>
IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip block is documented below.
vni Integer
VXLAN network ID.
vdomparam String
dstport number
VXLAN destination port (1 - 65535, default = 4789).
evpnId number
EVPN instance.
id string
The provider-assigned unique ID for this managed resource.
interface string
Outgoing interface for VXLAN encapsulated traffic.
ipVersion string
IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast.
learnFromTraffic string
Enable/disable VXLAN MAC learning from traffic.
multicastTtl number
VXLAN multicast TTL (1-255, default = 0).
name string
VXLAN device or interface name. Must be a unique interface name.
remoteIp6s GetVxlanRemoteIp6[]
IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip6 block is documented below.
remoteIps GetVxlanRemoteIp[]
IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip block is documented below.
vni number
VXLAN network ID.
vdomparam string
dstport int
VXLAN destination port (1 - 65535, default = 4789).
evpn_id int
EVPN instance.
id str
The provider-assigned unique ID for this managed resource.
interface str
Outgoing interface for VXLAN encapsulated traffic.
ip_version str
IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast.
learn_from_traffic str
Enable/disable VXLAN MAC learning from traffic.
multicast_ttl int
VXLAN multicast TTL (1-255, default = 0).
name str
VXLAN device or interface name. Must be a unique interface name.
remote_ip6s Sequence[GetVxlanRemoteIp6]
IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip6 block is documented below.
remote_ips Sequence[GetVxlanRemoteIp]
IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip block is documented below.
vni int
VXLAN network ID.
vdomparam str
dstport Number
VXLAN destination port (1 - 65535, default = 4789).
evpnId Number
EVPN instance.
id String
The provider-assigned unique ID for this managed resource.
interface String
Outgoing interface for VXLAN encapsulated traffic.
ipVersion String
IP version to use for the VXLAN interface and so for communication over the VXLAN. IPv4 or IPv6 unicast or multicast.
learnFromTraffic String
Enable/disable VXLAN MAC learning from traffic.
multicastTtl Number
VXLAN multicast TTL (1-255, default = 0).
name String
VXLAN device or interface name. Must be a unique interface name.
remoteIp6s List<Property Map>
IPv6 IP address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip6 block is documented below.
remoteIps List<Property Map>
IPv4 address of the VXLAN interface on the device at the remote end of the VXLAN. The structure of remote_ip block is documented below.
vni Number
VXLAN network ID.
vdomparam String

Supporting Types

GetVxlanRemoteIp

Ip This property is required. string
IPv4 address.
Ip This property is required. string
IPv4 address.
ip This property is required. String
IPv4 address.
ip This property is required. string
IPv4 address.
ip This property is required. str
IPv4 address.
ip This property is required. String
IPv4 address.

GetVxlanRemoteIp6

Ip6 This property is required. string
IPv6 address.
Ip6 This property is required. string
IPv6 address.
ip6 This property is required. String
IPv6 address.
ip6 This property is required. string
IPv6 address.
ip6 This property is required. str
IPv6 address.
ip6 This property is required. String
IPv6 address.

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