Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. F5 BIG-IP
  3. API Docs
  4. ltm
  5. VirtualAddress
f5 BIG-IP v3.17.4 published on Wednesday, Sep 11, 2024 by Pulumi
pulumi/pulumi-f5bigip

f5bigip.ltm.VirtualAddress

Explore with Pulumi AI

f5bigip logo
f5 BIG-IP v3.17.4 published on Wednesday, Sep 11, 2024 by Pulumi
pulumi/pulumi-f5bigip

    f5bigip.ltm.VirtualAddress Configures Virtual Server

    For resources should be named with their “full path”. The full path is the combination of the partition + name of the resource. For example /Common/virtual_server.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as f5bigip from "@pulumi/f5bigip";

const vsVa = new f5bigip.ltm.VirtualAddress("vs_va", {
    name: "/Common/xxxxx",
    advertizeRoute: "enabled",
});

    import pulumi
import pulumi_f5bigip as f5bigip

vs_va = f5bigip.ltm.VirtualAddress("vs_va",
    name="/Common/xxxxx",
    advertize_route="enabled")

    package main

import (
	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip/ltm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ltm.NewVirtualAddress(ctx, "vs_va", &ltm.VirtualAddressArgs{
			Name:           pulumi.String("/Common/xxxxx"),
			AdvertizeRoute: pulumi.String("enabled"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using F5BigIP = Pulumi.F5BigIP;

return await Deployment.RunAsync(() => 
{
    var vsVa = new F5BigIP.Ltm.VirtualAddress("vs_va", new()
    {
        Name = "/Common/xxxxx",
        AdvertizeRoute = "enabled",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.f5bigip.ltm.VirtualAddress;
import com.pulumi.f5bigip.ltm.VirtualAddressArgs;
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 vsVa = new VirtualAddress("vsVa", VirtualAddressArgs.builder()
            .name("/Common/xxxxx")
            .advertizeRoute("enabled")
            .build());

    }
}

    resources:
  vsVa:
    type: f5bigip:ltm:VirtualAddress
    name: vs_va
    properties:
      name: /Common/xxxxx
      advertizeRoute: enabled

    Create VirtualAddress Resource

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

    Constructor syntax

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

@overload
def VirtualAddress(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   name: Optional[str] = None,
                   advertize_route: Optional[str] = None,
                   arp: Optional[bool] = None,
                   auto_delete: Optional[bool] = None,
                   conn_limit: Optional[int] = None,
                   enabled: Optional[bool] = None,
                   icmp_echo: Optional[str] = None,
                   traffic_group: Optional[str] = None)
    func NewVirtualAddress(ctx *Context, name string, args VirtualAddressArgs, opts ...ResourceOption) (*VirtualAddress, error)
    public VirtualAddress(string name, VirtualAddressArgs args, CustomResourceOptions? opts = null)
    public VirtualAddress(String name, VirtualAddressArgs args)
public VirtualAddress(String name, VirtualAddressArgs args, CustomResourceOptions options)

    type: f5bigip:ltm:VirtualAddress
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 VirtualAddressArgs
    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 VirtualAddressArgs
    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 VirtualAddressArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VirtualAddressArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VirtualAddressArgs
    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 virtualAddressResource = new F5BigIP.Ltm.VirtualAddress("virtualAddressResource", new()
{
    Name = "string",
    AdvertizeRoute = "string",
    Arp = false,
    AutoDelete = false,
    ConnLimit = 0,
    Enabled = false,
    IcmpEcho = "string",
    TrafficGroup = "string",
});

    example, err := ltm.NewVirtualAddress(ctx, "virtualAddressResource", &ltm.VirtualAddressArgs{
	Name:           pulumi.String("string"),
	AdvertizeRoute: pulumi.String("string"),
	Arp:            pulumi.Bool(false),
	AutoDelete:     pulumi.Bool(false),
	ConnLimit:      pulumi.Int(0),
	Enabled:        pulumi.Bool(false),
	IcmpEcho:       pulumi.String("string"),
	TrafficGroup:   pulumi.String("string"),
})

    var virtualAddressResource = new VirtualAddress("virtualAddressResource", VirtualAddressArgs.builder()
    .name("string")
    .advertizeRoute("string")
    .arp(false)
    .autoDelete(false)
    .connLimit(0)
    .enabled(false)
    .icmpEcho("string")
    .trafficGroup("string")
    .build());

    virtual_address_resource = f5bigip.ltm.VirtualAddress("virtualAddressResource",
    name="string",
    advertize_route="string",
    arp=False,
    auto_delete=False,
    conn_limit=0,
    enabled=False,
    icmp_echo="string",
    traffic_group="string")

    const virtualAddressResource = new f5bigip.ltm.VirtualAddress("virtualAddressResource", {
    name: "string",
    advertizeRoute: "string",
    arp: false,
    autoDelete: false,
    connLimit: 0,
    enabled: false,
    icmpEcho: "string",
    trafficGroup: "string",
});

    type: f5bigip:ltm:VirtualAddress
properties:
    advertizeRoute: string
    arp: false
    autoDelete: false
    connLimit: 0
    enabled: false
    icmpEcho: string
    name: string
    trafficGroup: string

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

    Name string
    Name of the virtual address
    AdvertizeRoute string
    Enabled dynamic routing of the address ( In versions prior to BIG-IP 13.0.0 HF1, you can configure the Route Advertisement option for a virtual address to be either Enabled or Disabled only. Beginning with BIG-IP 13.0.0 HF1, F5 added more settings for the Route Advertisement option. In addition, the Enabled setting is deprecated and replaced by the Selective setting. For more information, please look into KB article https://support.f5.com/csp/article/K85543242 )
    Arp bool
    Enable or disable ARP for the virtual address
    AutoDelete bool
    Automatically delete the virtual address with the virtual server
    ConnLimit int
    Max number of connections for virtual address
    Enabled bool
    Enable or disable the virtual address
    IcmpEcho string
    Specifies how the system sends responses to ICMP echo requests on a per-virtual address basis.
    TrafficGroup string
    Specify the partition and traffic group
    Name string
    Name of the virtual address
    AdvertizeRoute string
    Enabled dynamic routing of the address ( In versions prior to BIG-IP 13.0.0 HF1, you can configure the Route Advertisement option for a virtual address to be either Enabled or Disabled only. Beginning with BIG-IP 13.0.0 HF1, F5 added more settings for the Route Advertisement option. In addition, the Enabled setting is deprecated and replaced by the Selective setting. For more information, please look into KB article https://support.f5.com/csp/article/K85543242 )
    Arp bool
    Enable or disable ARP for the virtual address
    AutoDelete bool
    Automatically delete the virtual address with the virtual server
    ConnLimit int
    Max number of connections for virtual address
    Enabled bool
    Enable or disable the virtual address
    IcmpEcho string
    Specifies how the system sends responses to ICMP echo requests on a per-virtual address basis.
    TrafficGroup string
    Specify the partition and traffic group
    name String
    Name of the virtual address
    advertizeRoute String
    Enabled dynamic routing of the address ( In versions prior to BIG-IP 13.0.0 HF1, you can configure the Route Advertisement option for a virtual address to be either Enabled or Disabled only. Beginning with BIG-IP 13.0.0 HF1, F5 added more settings for the Route Advertisement option. In addition, the Enabled setting is deprecated and replaced by the Selective setting. For more information, please look into KB article https://support.f5.com/csp/article/K85543242 )
    arp Boolean
    Enable or disable ARP for the virtual address
    autoDelete Boolean
    Automatically delete the virtual address with the virtual server
    connLimit Integer
    Max number of connections for virtual address
    enabled Boolean
    Enable or disable the virtual address
    icmpEcho String
    Specifies how the system sends responses to ICMP echo requests on a per-virtual address basis.
    trafficGroup String
    Specify the partition and traffic group
    name string
    Name of the virtual address
    advertizeRoute string
    Enabled dynamic routing of the address ( In versions prior to BIG-IP 13.0.0 HF1, you can configure the Route Advertisement option for a virtual address to be either Enabled or Disabled only. Beginning with BIG-IP 13.0.0 HF1, F5 added more settings for the Route Advertisement option. In addition, the Enabled setting is deprecated and replaced by the Selective setting. For more information, please look into KB article https://support.f5.com/csp/article/K85543242 )
    arp boolean
    Enable or disable ARP for the virtual address
    autoDelete boolean
    Automatically delete the virtual address with the virtual server
    connLimit number
    Max number of connections for virtual address
    enabled boolean
    Enable or disable the virtual address
    icmpEcho string
    Specifies how the system sends responses to ICMP echo requests on a per-virtual address basis.
    trafficGroup string
    Specify the partition and traffic group
    name str
    Name of the virtual address
    advertize_route str
    Enabled dynamic routing of the address ( In versions prior to BIG-IP 13.0.0 HF1, you can configure the Route Advertisement option for a virtual address to be either Enabled or Disabled only. Beginning with BIG-IP 13.0.0 HF1, F5 added more settings for the Route Advertisement option. In addition, the Enabled setting is deprecated and replaced by the Selective setting. For more information, please look into KB article https://support.f5.com/csp/article/K85543242 )
    arp bool
    Enable or disable ARP for the virtual address
    auto_delete bool
    Automatically delete the virtual address with the virtual server
    conn_limit int
    Max number of connections for virtual address
    enabled bool
    Enable or disable the virtual address
    icmp_echo str
    Specifies how the system sends responses to ICMP echo requests on a per-virtual address basis.
    traffic_group str
    Specify the partition and traffic group
    name String
    Name of the virtual address
    advertizeRoute String
    Enabled dynamic routing of the address ( In versions prior to BIG-IP 13.0.0 HF1, you can configure the Route Advertisement option for a virtual address to be either Enabled or Disabled only. Beginning with BIG-IP 13.0.0 HF1, F5 added more settings for the Route Advertisement option. In addition, the Enabled setting is deprecated and replaced by the Selective setting. For more information, please look into KB article https://support.f5.com/csp/article/K85543242 )
    arp Boolean
    Enable or disable ARP for the virtual address
    autoDelete Boolean
    Automatically delete the virtual address with the virtual server
    connLimit Number
    Max number of connections for virtual address
    enabled Boolean
    Enable or disable the virtual address
    icmpEcho String
    Specifies how the system sends responses to ICMP echo requests on a per-virtual address basis.
    trafficGroup String
    Specify the partition and traffic group

    Outputs

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

    Get an existing VirtualAddress 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?: VirtualAddressState, opts?: CustomResourceOptions): VirtualAddress
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        advertize_route: Optional[str] = None,
        arp: Optional[bool] = None,
        auto_delete: Optional[bool] = None,
        conn_limit: Optional[int] = None,
        enabled: Optional[bool] = None,
        icmp_echo: Optional[str] = None,
        name: Optional[str] = None,
        traffic_group: Optional[str] = None) -> VirtualAddress
    func GetVirtualAddress(ctx *Context, name string, id IDInput, state *VirtualAddressState, opts ...ResourceOption) (*VirtualAddress, error)
    public static VirtualAddress Get(string name, Input<string> id, VirtualAddressState? state, CustomResourceOptions? opts = null)
    public static VirtualAddress get(String name, Output<String> id, VirtualAddressState 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:
    AdvertizeRoute string
    Enabled dynamic routing of the address ( In versions prior to BIG-IP 13.0.0 HF1, you can configure the Route Advertisement option for a virtual address to be either Enabled or Disabled only. Beginning with BIG-IP 13.0.0 HF1, F5 added more settings for the Route Advertisement option. In addition, the Enabled setting is deprecated and replaced by the Selective setting. For more information, please look into KB article https://support.f5.com/csp/article/K85543242 )
    Arp bool
    Enable or disable ARP for the virtual address
    AutoDelete bool
    Automatically delete the virtual address with the virtual server
    ConnLimit int
    Max number of connections for virtual address
    Enabled bool
    Enable or disable the virtual address
    IcmpEcho string
    Specifies how the system sends responses to ICMP echo requests on a per-virtual address basis.
    Name string
    Name of the virtual address
    TrafficGroup string
    Specify the partition and traffic group
    AdvertizeRoute string
    Enabled dynamic routing of the address ( In versions prior to BIG-IP 13.0.0 HF1, you can configure the Route Advertisement option for a virtual address to be either Enabled or Disabled only. Beginning with BIG-IP 13.0.0 HF1, F5 added more settings for the Route Advertisement option. In addition, the Enabled setting is deprecated and replaced by the Selective setting. For more information, please look into KB article https://support.f5.com/csp/article/K85543242 )
    Arp bool
    Enable or disable ARP for the virtual address
    AutoDelete bool
    Automatically delete the virtual address with the virtual server
    ConnLimit int
    Max number of connections for virtual address
    Enabled bool
    Enable or disable the virtual address
    IcmpEcho string
    Specifies how the system sends responses to ICMP echo requests on a per-virtual address basis.
    Name string
    Name of the virtual address
    TrafficGroup string
    Specify the partition and traffic group
    advertizeRoute String
    Enabled dynamic routing of the address ( In versions prior to BIG-IP 13.0.0 HF1, you can configure the Route Advertisement option for a virtual address to be either Enabled or Disabled only. Beginning with BIG-IP 13.0.0 HF1, F5 added more settings for the Route Advertisement option. In addition, the Enabled setting is deprecated and replaced by the Selective setting. For more information, please look into KB article https://support.f5.com/csp/article/K85543242 )
    arp Boolean
    Enable or disable ARP for the virtual address
    autoDelete Boolean
    Automatically delete the virtual address with the virtual server
    connLimit Integer
    Max number of connections for virtual address
    enabled Boolean
    Enable or disable the virtual address
    icmpEcho String
    Specifies how the system sends responses to ICMP echo requests on a per-virtual address basis.
    name String
    Name of the virtual address
    trafficGroup String
    Specify the partition and traffic group
    advertizeRoute string
    Enabled dynamic routing of the address ( In versions prior to BIG-IP 13.0.0 HF1, you can configure the Route Advertisement option for a virtual address to be either Enabled or Disabled only. Beginning with BIG-IP 13.0.0 HF1, F5 added more settings for the Route Advertisement option. In addition, the Enabled setting is deprecated and replaced by the Selective setting. For more information, please look into KB article https://support.f5.com/csp/article/K85543242 )
    arp boolean
    Enable or disable ARP for the virtual address
    autoDelete boolean
    Automatically delete the virtual address with the virtual server
    connLimit number
    Max number of connections for virtual address
    enabled boolean
    Enable or disable the virtual address
    icmpEcho string
    Specifies how the system sends responses to ICMP echo requests on a per-virtual address basis.
    name string
    Name of the virtual address
    trafficGroup string
    Specify the partition and traffic group
    advertize_route str
    Enabled dynamic routing of the address ( In versions prior to BIG-IP 13.0.0 HF1, you can configure the Route Advertisement option for a virtual address to be either Enabled or Disabled only. Beginning with BIG-IP 13.0.0 HF1, F5 added more settings for the Route Advertisement option. In addition, the Enabled setting is deprecated and replaced by the Selective setting. For more information, please look into KB article https://support.f5.com/csp/article/K85543242 )
    arp bool
    Enable or disable ARP for the virtual address
    auto_delete bool
    Automatically delete the virtual address with the virtual server
    conn_limit int
    Max number of connections for virtual address
    enabled bool
    Enable or disable the virtual address
    icmp_echo str
    Specifies how the system sends responses to ICMP echo requests on a per-virtual address basis.
    name str
    Name of the virtual address
    traffic_group str
    Specify the partition and traffic group
    advertizeRoute String
    Enabled dynamic routing of the address ( In versions prior to BIG-IP 13.0.0 HF1, you can configure the Route Advertisement option for a virtual address to be either Enabled or Disabled only. Beginning with BIG-IP 13.0.0 HF1, F5 added more settings for the Route Advertisement option. In addition, the Enabled setting is deprecated and replaced by the Selective setting. For more information, please look into KB article https://support.f5.com/csp/article/K85543242 )
    arp Boolean
    Enable or disable ARP for the virtual address
    autoDelete Boolean
    Automatically delete the virtual address with the virtual server
    connLimit Number
    Max number of connections for virtual address
    enabled Boolean
    Enable or disable the virtual address
    icmpEcho String
    Specifies how the system sends responses to ICMP echo requests on a per-virtual address basis.
    name String
    Name of the virtual address
    trafficGroup String
    Specify the partition and traffic group

    Package Details

    Repository
    f5 BIG-IP pulumi/pulumi-f5bigip
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the bigip Terraform Provider.
    f5bigip logo
    f5 BIG-IP v3.17.4 published on Wednesday, Sep 11, 2024 by Pulumi
    pulumi/pulumi-f5bigip