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

f5bigip.ltm.VirtualServer

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.VirtualServer 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 (example: /Common/test-virtualserver ) or partition + directory + name of the resource (example: /Common/test/test-virtualserver ). When including directory in fullpath we have to make sure it is created in the given partition before using it.

    Create VirtualServer Resource

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

    Constructor syntax

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

@overload
def VirtualServer(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  name: Optional[str] = None,
                  port: Optional[int] = None,
                  vlans_enabled: Optional[bool] = None,
                  pool: Optional[str] = None,
                  fallback_persistence_profile: Optional[str] = None,
                  firewall_enforced_policy: Optional[str] = None,
                  ip_protocol: Optional[str] = None,
                  irules: Optional[Sequence[str]] = None,
                  mask: Optional[str] = None,
                  default_persistence_profile: Optional[str] = None,
                  per_flow_request_access_policy: Optional[str] = None,
                  persistence_profiles: Optional[Sequence[str]] = None,
                  policies: Optional[Sequence[str]] = None,
                  destination: Optional[str] = None,
                  description: Optional[str] = None,
                  state: Optional[str] = None,
                  security_log_profiles: Optional[Sequence[str]] = None,
                  server_profiles: Optional[Sequence[str]] = None,
                  snatpool: Optional[str] = None,
                  source: Optional[str] = None,
                  source_address_translation: Optional[str] = None,
                  source_port: Optional[str] = None,
                  profiles: Optional[Sequence[str]] = None,
                  trafficmatching_criteria: Optional[str] = None,
                  translate_address: Optional[str] = None,
                  translate_port: Optional[str] = None,
                  vlans: Optional[Sequence[str]] = None,
                  client_profiles: Optional[Sequence[str]] = None)
    func NewVirtualServer(ctx *Context, name string, args VirtualServerArgs, opts ...ResourceOption) (*VirtualServer, error)
    public VirtualServer(string name, VirtualServerArgs args, CustomResourceOptions? opts = null)
    public VirtualServer(String name, VirtualServerArgs args)
public VirtualServer(String name, VirtualServerArgs args, CustomResourceOptions options)

    type: f5bigip:ltm:VirtualServer
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 VirtualServerArgs
    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 VirtualServerArgs
    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 VirtualServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VirtualServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VirtualServerArgs
    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 virtualServerResource = new F5BigIP.Ltm.VirtualServer("virtualServerResource", new()
{
    Name = "string",
    Port = 0,
    VlansEnabled = false,
    Pool = "string",
    FallbackPersistenceProfile = "string",
    FirewallEnforcedPolicy = "string",
    IpProtocol = "string",
    Irules = new[]
    {
        "string",
    },
    Mask = "string",
    DefaultPersistenceProfile = "string",
    PerFlowRequestAccessPolicy = "string",
    PersistenceProfiles = new[]
    {
        "string",
    },
    Policies = new[]
    {
        "string",
    },
    Destination = "string",
    Description = "string",
    State = "string",
    SecurityLogProfiles = new[]
    {
        "string",
    },
    ServerProfiles = new[]
    {
        "string",
    },
    Snatpool = "string",
    Source = "string",
    SourceAddressTranslation = "string",
    SourcePort = "string",
    Profiles = new[]
    {
        "string",
    },
    TrafficmatchingCriteria = "string",
    TranslateAddress = "string",
    TranslatePort = "string",
    Vlans = new[]
    {
        "string",
    },
    ClientProfiles = new[]
    {
        "string",
    },
});

    example, err := ltm.NewVirtualServer(ctx, "virtualServerResource", &ltm.VirtualServerArgs{
	Name:                       pulumi.String("string"),
	Port:                       pulumi.Int(0),
	VlansEnabled:               pulumi.Bool(false),
	Pool:                       pulumi.String("string"),
	FallbackPersistenceProfile: pulumi.String("string"),
	FirewallEnforcedPolicy:     pulumi.String("string"),
	IpProtocol:                 pulumi.String("string"),
	Irules: pulumi.StringArray{
		pulumi.String("string"),
	},
	Mask:                       pulumi.String("string"),
	DefaultPersistenceProfile:  pulumi.String("string"),
	PerFlowRequestAccessPolicy: pulumi.String("string"),
	PersistenceProfiles: pulumi.StringArray{
		pulumi.String("string"),
	},
	Policies: pulumi.StringArray{
		pulumi.String("string"),
	},
	Destination: pulumi.String("string"),
	Description: pulumi.String("string"),
	State:       pulumi.String("string"),
	SecurityLogProfiles: pulumi.StringArray{
		pulumi.String("string"),
	},
	ServerProfiles: pulumi.StringArray{
		pulumi.String("string"),
	},
	Snatpool:                 pulumi.String("string"),
	Source:                   pulumi.String("string"),
	SourceAddressTranslation: pulumi.String("string"),
	SourcePort:               pulumi.String("string"),
	Profiles: pulumi.StringArray{
		pulumi.String("string"),
	},
	TrafficmatchingCriteria: pulumi.String("string"),
	TranslateAddress:        pulumi.String("string"),
	TranslatePort:           pulumi.String("string"),
	Vlans: pulumi.StringArray{
		pulumi.String("string"),
	},
	ClientProfiles: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var virtualServerResource = new VirtualServer("virtualServerResource", VirtualServerArgs.builder()
    .name("string")
    .port(0)
    .vlansEnabled(false)
    .pool("string")
    .fallbackPersistenceProfile("string")
    .firewallEnforcedPolicy("string")
    .ipProtocol("string")
    .irules("string")
    .mask("string")
    .defaultPersistenceProfile("string")
    .perFlowRequestAccessPolicy("string")
    .persistenceProfiles("string")
    .policies("string")
    .destination("string")
    .description("string")
    .state("string")
    .securityLogProfiles("string")
    .serverProfiles("string")
    .snatpool("string")
    .source("string")
    .sourceAddressTranslation("string")
    .sourcePort("string")
    .profiles("string")
    .trafficmatchingCriteria("string")
    .translateAddress("string")
    .translatePort("string")
    .vlans("string")
    .clientProfiles("string")
    .build());

    virtual_server_resource = f5bigip.ltm.VirtualServer("virtualServerResource",
    name="string",
    port=0,
    vlans_enabled=False,
    pool="string",
    fallback_persistence_profile="string",
    firewall_enforced_policy="string",
    ip_protocol="string",
    irules=["string"],
    mask="string",
    default_persistence_profile="string",
    per_flow_request_access_policy="string",
    persistence_profiles=["string"],
    policies=["string"],
    destination="string",
    description="string",
    state="string",
    security_log_profiles=["string"],
    server_profiles=["string"],
    snatpool="string",
    source="string",
    source_address_translation="string",
    source_port="string",
    profiles=["string"],
    trafficmatching_criteria="string",
    translate_address="string",
    translate_port="string",
    vlans=["string"],
    client_profiles=["string"])

    const virtualServerResource = new f5bigip.ltm.VirtualServer("virtualServerResource", {
    name: "string",
    port: 0,
    vlansEnabled: false,
    pool: "string",
    fallbackPersistenceProfile: "string",
    firewallEnforcedPolicy: "string",
    ipProtocol: "string",
    irules: ["string"],
    mask: "string",
    defaultPersistenceProfile: "string",
    perFlowRequestAccessPolicy: "string",
    persistenceProfiles: ["string"],
    policies: ["string"],
    destination: "string",
    description: "string",
    state: "string",
    securityLogProfiles: ["string"],
    serverProfiles: ["string"],
    snatpool: "string",
    source: "string",
    sourceAddressTranslation: "string",
    sourcePort: "string",
    profiles: ["string"],
    trafficmatchingCriteria: "string",
    translateAddress: "string",
    translatePort: "string",
    vlans: ["string"],
    clientProfiles: ["string"],
});

    type: f5bigip:ltm:VirtualServer
properties:
    clientProfiles:
        - string
    defaultPersistenceProfile: string
    description: string
    destination: string
    fallbackPersistenceProfile: string
    firewallEnforcedPolicy: string
    ipProtocol: string
    irules:
        - string
    mask: string
    name: string
    perFlowRequestAccessPolicy: string
    persistenceProfiles:
        - string
    policies:
        - string
    pool: string
    port: 0
    profiles:
        - string
    securityLogProfiles:
        - string
    serverProfiles:
        - string
    snatpool: string
    source: string
    sourceAddressTranslation: string
    sourcePort: string
    state: string
    trafficmatchingCriteria: string
    translateAddress: string
    translatePort: string
    vlans:
        - string
    vlansEnabled: false

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

    Name string
    Name of the virtual server
    ClientProfiles List<string>
    List of client context profiles associated on the virtual server. Not mutually exclusive with profiles and server_profiles
    DefaultPersistenceProfile string
    Description string
    Description of Virtual server
    Destination string
    Destination IP
    FallbackPersistenceProfile string
    Specifies a fallback persistence profile for the Virtual Server to use when the default persistence profile is not available.
    FirewallEnforcedPolicy string
    Applies the specified AFM policy to the virtual in an enforcing way,when creating a new virtual, if this parameter is not specified, the enforced is disabled.This should be in full path ex: /Common/afm-test-policy.
    IpProtocol string
    Specifies a network protocol name you want the system to use to direct traffic on this virtual server. The default is tcp. valid options are [any,udp,tcp]
    Irules List<string>
    The iRules list you want run on this virtual server. iRules help automate the intercepting, processing, and routing of application traffic.
    Mask string
    Mask can either be in CIDR notation or decimal, i.e.: 24 or 255.255.255.0. A CIDR mask of 0 is the same as 0.0.0.0
    PerFlowRequestAccessPolicy string
    PersistenceProfiles List<string>
    List of persistence profiles associated with the Virtual Server.
    Policies List<string>
    Specifies the policies for the virtual server.
    Pool string
    Default pool name
    Port int
    Listen port for the virtual server
    Profiles List<string>
    List of profiles associated both client and server contexts on the virtual server. This includes protocol, ssl, http, etc.
    SecurityLogProfiles List<string>
    Specifies the log profile applied to the virtual server.
    ServerProfiles List<string>
    List of server context profiles associated on the virtual server. Not mutually exclusive with profiles and client_profiles
    Snatpool string
    Specifies the name of an existing SNAT pool that you want the virtual server to use to implement selective and intelligent SNATs.
    Source string
    Specifies an IP address or network from which the virtual server will accept traffic.
    SourceAddressTranslation string
    Can be either omitted for none or the values automap options : [snat,automap,none].
    SourcePort string
    Specifies whether the system preserves the source port of the connection. The default is preserve.
    State string
    Specifies whether the virtual server and its resources are available for load balancing. The default is Enabled
    TrafficmatchingCriteria string
    Specifies destination traffic matching information to which the virtual server sends traffic
    TranslateAddress string
    Enables or disables address translation for the virtual server. Turn address translation off for a virtual server if you want to use the virtual server to load balance connections to any address. This option is useful when the system is load balancing devices that have the same IP address.
    TranslatePort string
    Enables or disables port translation. Turn port translation off for a virtual server if you want to use the virtual server to load balance connections to any service
    Vlans List<string>
    The virtual server is enabled/disabled on this set of VLANs,enable/disabled will be desided by attribute vlan_enabled
    VlansEnabled bool
    Enables the virtual server on the VLANs specified by the vlans option. By default it is false i.e vlanDisabled on specified vlans, if we want enable virtual server on VLANs specified by vlans, mark this attribute to true.
    Name string
    Name of the virtual server
    ClientProfiles []string
    List of client context profiles associated on the virtual server. Not mutually exclusive with profiles and server_profiles
    DefaultPersistenceProfile string
    Description string
    Description of Virtual server
    Destination string
    Destination IP
    FallbackPersistenceProfile string
    Specifies a fallback persistence profile for the Virtual Server to use when the default persistence profile is not available.
    FirewallEnforcedPolicy string
    Applies the specified AFM policy to the virtual in an enforcing way,when creating a new virtual, if this parameter is not specified, the enforced is disabled.This should be in full path ex: /Common/afm-test-policy.
    IpProtocol string
    Specifies a network protocol name you want the system to use to direct traffic on this virtual server. The default is tcp. valid options are [any,udp,tcp]
    Irules []string
    The iRules list you want run on this virtual server. iRules help automate the intercepting, processing, and routing of application traffic.
    Mask string
    Mask can either be in CIDR notation or decimal, i.e.: 24 or 255.255.255.0. A CIDR mask of 0 is the same as 0.0.0.0
    PerFlowRequestAccessPolicy string
    PersistenceProfiles []string
    List of persistence profiles associated with the Virtual Server.
    Policies []string
    Specifies the policies for the virtual server.
    Pool string
    Default pool name
    Port int
    Listen port for the virtual server
    Profiles []string
    List of profiles associated both client and server contexts on the virtual server. This includes protocol, ssl, http, etc.
    SecurityLogProfiles []string
    Specifies the log profile applied to the virtual server.
    ServerProfiles []string
    List of server context profiles associated on the virtual server. Not mutually exclusive with profiles and client_profiles
    Snatpool string
    Specifies the name of an existing SNAT pool that you want the virtual server to use to implement selective and intelligent SNATs.
    Source string
    Specifies an IP address or network from which the virtual server will accept traffic.
    SourceAddressTranslation string
    Can be either omitted for none or the values automap options : [snat,automap,none].
    SourcePort string
    Specifies whether the system preserves the source port of the connection. The default is preserve.
    State string
    Specifies whether the virtual server and its resources are available for load balancing. The default is Enabled
    TrafficmatchingCriteria string
    Specifies destination traffic matching information to which the virtual server sends traffic
    TranslateAddress string
    Enables or disables address translation for the virtual server. Turn address translation off for a virtual server if you want to use the virtual server to load balance connections to any address. This option is useful when the system is load balancing devices that have the same IP address.
    TranslatePort string
    Enables or disables port translation. Turn port translation off for a virtual server if you want to use the virtual server to load balance connections to any service
    Vlans []string
    The virtual server is enabled/disabled on this set of VLANs,enable/disabled will be desided by attribute vlan_enabled
    VlansEnabled bool
    Enables the virtual server on the VLANs specified by the vlans option. By default it is false i.e vlanDisabled on specified vlans, if we want enable virtual server on VLANs specified by vlans, mark this attribute to true.
    name String
    Name of the virtual server
    clientProfiles List<String>
    List of client context profiles associated on the virtual server. Not mutually exclusive with profiles and server_profiles
    defaultPersistenceProfile String
    description String
    Description of Virtual server
    destination String
    Destination IP
    fallbackPersistenceProfile String
    Specifies a fallback persistence profile for the Virtual Server to use when the default persistence profile is not available.
    firewallEnforcedPolicy String
    Applies the specified AFM policy to the virtual in an enforcing way,when creating a new virtual, if this parameter is not specified, the enforced is disabled.This should be in full path ex: /Common/afm-test-policy.
    ipProtocol String
    Specifies a network protocol name you want the system to use to direct traffic on this virtual server. The default is tcp. valid options are [any,udp,tcp]
    irules List<String>
    The iRules list you want run on this virtual server. iRules help automate the intercepting, processing, and routing of application traffic.
    mask String
    Mask can either be in CIDR notation or decimal, i.e.: 24 or 255.255.255.0. A CIDR mask of 0 is the same as 0.0.0.0
    perFlowRequestAccessPolicy String
    persistenceProfiles List<String>
    List of persistence profiles associated with the Virtual Server.
    policies List<String>
    Specifies the policies for the virtual server.
    pool String
    Default pool name
    port Integer
    Listen port for the virtual server
    profiles List<String>
    List of profiles associated both client and server contexts on the virtual server. This includes protocol, ssl, http, etc.
    securityLogProfiles List<String>
    Specifies the log profile applied to the virtual server.
    serverProfiles List<String>
    List of server context profiles associated on the virtual server. Not mutually exclusive with profiles and client_profiles
    snatpool String
    Specifies the name of an existing SNAT pool that you want the virtual server to use to implement selective and intelligent SNATs.
    source String
    Specifies an IP address or network from which the virtual server will accept traffic.
    sourceAddressTranslation String
    Can be either omitted for none or the values automap options : [snat,automap,none].
    sourcePort String
    Specifies whether the system preserves the source port of the connection. The default is preserve.
    state String
    Specifies whether the virtual server and its resources are available for load balancing. The default is Enabled
    trafficmatchingCriteria String
    Specifies destination traffic matching information to which the virtual server sends traffic
    translateAddress String
    Enables or disables address translation for the virtual server. Turn address translation off for a virtual server if you want to use the virtual server to load balance connections to any address. This option is useful when the system is load balancing devices that have the same IP address.
    translatePort String
    Enables or disables port translation. Turn port translation off for a virtual server if you want to use the virtual server to load balance connections to any service
    vlans List<String>
    The virtual server is enabled/disabled on this set of VLANs,enable/disabled will be desided by attribute vlan_enabled
    vlansEnabled Boolean
    Enables the virtual server on the VLANs specified by the vlans option. By default it is false i.e vlanDisabled on specified vlans, if we want enable virtual server on VLANs specified by vlans, mark this attribute to true.
    name string
    Name of the virtual server
    clientProfiles string[]
    List of client context profiles associated on the virtual server. Not mutually exclusive with profiles and server_profiles
    defaultPersistenceProfile string
    description string
    Description of Virtual server
    destination string
    Destination IP
    fallbackPersistenceProfile string
    Specifies a fallback persistence profile for the Virtual Server to use when the default persistence profile is not available.
    firewallEnforcedPolicy string
    Applies the specified AFM policy to the virtual in an enforcing way,when creating a new virtual, if this parameter is not specified, the enforced is disabled.This should be in full path ex: /Common/afm-test-policy.
    ipProtocol string
    Specifies a network protocol name you want the system to use to direct traffic on this virtual server. The default is tcp. valid options are [any,udp,tcp]
    irules string[]
    The iRules list you want run on this virtual server. iRules help automate the intercepting, processing, and routing of application traffic.
    mask string
    Mask can either be in CIDR notation or decimal, i.e.: 24 or 255.255.255.0. A CIDR mask of 0 is the same as 0.0.0.0
    perFlowRequestAccessPolicy string
    persistenceProfiles string[]
    List of persistence profiles associated with the Virtual Server.
    policies string[]
    Specifies the policies for the virtual server.
    pool string
    Default pool name
    port number
    Listen port for the virtual server
    profiles string[]
    List of profiles associated both client and server contexts on the virtual server. This includes protocol, ssl, http, etc.
    securityLogProfiles string[]
    Specifies the log profile applied to the virtual server.
    serverProfiles string[]
    List of server context profiles associated on the virtual server. Not mutually exclusive with profiles and client_profiles
    snatpool string
    Specifies the name of an existing SNAT pool that you want the virtual server to use to implement selective and intelligent SNATs.
    source string
    Specifies an IP address or network from which the virtual server will accept traffic.
    sourceAddressTranslation string
    Can be either omitted for none or the values automap options : [snat,automap,none].
    sourcePort string
    Specifies whether the system preserves the source port of the connection. The default is preserve.
    state string
    Specifies whether the virtual server and its resources are available for load balancing. The default is Enabled
    trafficmatchingCriteria string
    Specifies destination traffic matching information to which the virtual server sends traffic
    translateAddress string
    Enables or disables address translation for the virtual server. Turn address translation off for a virtual server if you want to use the virtual server to load balance connections to any address. This option is useful when the system is load balancing devices that have the same IP address.
    translatePort string
    Enables or disables port translation. Turn port translation off for a virtual server if you want to use the virtual server to load balance connections to any service
    vlans string[]
    The virtual server is enabled/disabled on this set of VLANs,enable/disabled will be desided by attribute vlan_enabled
    vlansEnabled boolean
    Enables the virtual server on the VLANs specified by the vlans option. By default it is false i.e vlanDisabled on specified vlans, if we want enable virtual server on VLANs specified by vlans, mark this attribute to true.
    name str
    Name of the virtual server
    client_profiles Sequence[str]
    List of client context profiles associated on the virtual server. Not mutually exclusive with profiles and server_profiles
    default_persistence_profile str
    description str
    Description of Virtual server
    destination str
    Destination IP
    fallback_persistence_profile str
    Specifies a fallback persistence profile for the Virtual Server to use when the default persistence profile is not available.
    firewall_enforced_policy str
    Applies the specified AFM policy to the virtual in an enforcing way,when creating a new virtual, if this parameter is not specified, the enforced is disabled.This should be in full path ex: /Common/afm-test-policy.
    ip_protocol str
    Specifies a network protocol name you want the system to use to direct traffic on this virtual server. The default is tcp. valid options are [any,udp,tcp]
    irules Sequence[str]
    The iRules list you want run on this virtual server. iRules help automate the intercepting, processing, and routing of application traffic.
    mask str
    Mask can either be in CIDR notation or decimal, i.e.: 24 or 255.255.255.0. A CIDR mask of 0 is the same as 0.0.0.0
    per_flow_request_access_policy str
    persistence_profiles Sequence[str]
    List of persistence profiles associated with the Virtual Server.
    policies Sequence[str]
    Specifies the policies for the virtual server.
    pool str
    Default pool name
    port int
    Listen port for the virtual server
    profiles Sequence[str]
    List of profiles associated both client and server contexts on the virtual server. This includes protocol, ssl, http, etc.
    security_log_profiles Sequence[str]
    Specifies the log profile applied to the virtual server.
    server_profiles Sequence[str]
    List of server context profiles associated on the virtual server. Not mutually exclusive with profiles and client_profiles
    snatpool str
    Specifies the name of an existing SNAT pool that you want the virtual server to use to implement selective and intelligent SNATs.
    source str
    Specifies an IP address or network from which the virtual server will accept traffic.
    source_address_translation str
    Can be either omitted for none or the values automap options : [snat,automap,none].
    source_port str
    Specifies whether the system preserves the source port of the connection. The default is preserve.
    state str
    Specifies whether the virtual server and its resources are available for load balancing. The default is Enabled
    trafficmatching_criteria str
    Specifies destination traffic matching information to which the virtual server sends traffic
    translate_address str
    Enables or disables address translation for the virtual server. Turn address translation off for a virtual server if you want to use the virtual server to load balance connections to any address. This option is useful when the system is load balancing devices that have the same IP address.
    translate_port str
    Enables or disables port translation. Turn port translation off for a virtual server if you want to use the virtual server to load balance connections to any service
    vlans Sequence[str]
    The virtual server is enabled/disabled on this set of VLANs,enable/disabled will be desided by attribute vlan_enabled
    vlans_enabled bool
    Enables the virtual server on the VLANs specified by the vlans option. By default it is false i.e vlanDisabled on specified vlans, if we want enable virtual server on VLANs specified by vlans, mark this attribute to true.
    name String
    Name of the virtual server
    clientProfiles List<String>
    List of client context profiles associated on the virtual server. Not mutually exclusive with profiles and server_profiles
    defaultPersistenceProfile String
    description String
    Description of Virtual server
    destination String
    Destination IP
    fallbackPersistenceProfile String
    Specifies a fallback persistence profile for the Virtual Server to use when the default persistence profile is not available.
    firewallEnforcedPolicy String
    Applies the specified AFM policy to the virtual in an enforcing way,when creating a new virtual, if this parameter is not specified, the enforced is disabled.This should be in full path ex: /Common/afm-test-policy.
    ipProtocol String
    Specifies a network protocol name you want the system to use to direct traffic on this virtual server. The default is tcp. valid options are [any,udp,tcp]
    irules List<String>
    The iRules list you want run on this virtual server. iRules help automate the intercepting, processing, and routing of application traffic.
    mask String
    Mask can either be in CIDR notation or decimal, i.e.: 24 or 255.255.255.0. A CIDR mask of 0 is the same as 0.0.0.0
    perFlowRequestAccessPolicy String
    persistenceProfiles List<String>
    List of persistence profiles associated with the Virtual Server.
    policies List<String>
    Specifies the policies for the virtual server.
    pool String
    Default pool name
    port Number
    Listen port for the virtual server
    profiles List<String>
    List of profiles associated both client and server contexts on the virtual server. This includes protocol, ssl, http, etc.
    securityLogProfiles List<String>
    Specifies the log profile applied to the virtual server.
    serverProfiles List<String>
    List of server context profiles associated on the virtual server. Not mutually exclusive with profiles and client_profiles
    snatpool String
    Specifies the name of an existing SNAT pool that you want the virtual server to use to implement selective and intelligent SNATs.
    source String
    Specifies an IP address or network from which the virtual server will accept traffic.
    sourceAddressTranslation String
    Can be either omitted for none or the values automap options : [snat,automap,none].
    sourcePort String
    Specifies whether the system preserves the source port of the connection. The default is preserve.
    state String
    Specifies whether the virtual server and its resources are available for load balancing. The default is Enabled
    trafficmatchingCriteria String
    Specifies destination traffic matching information to which the virtual server sends traffic
    translateAddress String
    Enables or disables address translation for the virtual server. Turn address translation off for a virtual server if you want to use the virtual server to load balance connections to any address. This option is useful when the system is load balancing devices that have the same IP address.
    translatePort String
    Enables or disables port translation. Turn port translation off for a virtual server if you want to use the virtual server to load balance connections to any service
    vlans List<String>
    The virtual server is enabled/disabled on this set of VLANs,enable/disabled will be desided by attribute vlan_enabled
    vlansEnabled Boolean
    Enables the virtual server on the VLANs specified by the vlans option. By default it is false i.e vlanDisabled on specified vlans, if we want enable virtual server on VLANs specified by vlans, mark this attribute to true.

    Outputs

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

    Get an existing VirtualServer 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?: VirtualServerState, opts?: CustomResourceOptions): VirtualServer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_profiles: Optional[Sequence[str]] = None,
        default_persistence_profile: Optional[str] = None,
        description: Optional[str] = None,
        destination: Optional[str] = None,
        fallback_persistence_profile: Optional[str] = None,
        firewall_enforced_policy: Optional[str] = None,
        ip_protocol: Optional[str] = None,
        irules: Optional[Sequence[str]] = None,
        mask: Optional[str] = None,
        name: Optional[str] = None,
        per_flow_request_access_policy: Optional[str] = None,
        persistence_profiles: Optional[Sequence[str]] = None,
        policies: Optional[Sequence[str]] = None,
        pool: Optional[str] = None,
        port: Optional[int] = None,
        profiles: Optional[Sequence[str]] = None,
        security_log_profiles: Optional[Sequence[str]] = None,
        server_profiles: Optional[Sequence[str]] = None,
        snatpool: Optional[str] = None,
        source: Optional[str] = None,
        source_address_translation: Optional[str] = None,
        source_port: Optional[str] = None,
        state: Optional[str] = None,
        trafficmatching_criteria: Optional[str] = None,
        translate_address: Optional[str] = None,
        translate_port: Optional[str] = None,
        vlans: Optional[Sequence[str]] = None,
        vlans_enabled: Optional[bool] = None) -> VirtualServer
    func GetVirtualServer(ctx *Context, name string, id IDInput, state *VirtualServerState, opts ...ResourceOption) (*VirtualServer, error)
    public static VirtualServer Get(string name, Input<string> id, VirtualServerState? state, CustomResourceOptions? opts = null)
    public static VirtualServer get(String name, Output<String> id, VirtualServerState 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:
    ClientProfiles List<string>
    List of client context profiles associated on the virtual server. Not mutually exclusive with profiles and server_profiles
    DefaultPersistenceProfile string
    Description string
    Description of Virtual server
    Destination string
    Destination IP
    FallbackPersistenceProfile string
    Specifies a fallback persistence profile for the Virtual Server to use when the default persistence profile is not available.
    FirewallEnforcedPolicy string
    Applies the specified AFM policy to the virtual in an enforcing way,when creating a new virtual, if this parameter is not specified, the enforced is disabled.This should be in full path ex: /Common/afm-test-policy.
    IpProtocol string
    Specifies a network protocol name you want the system to use to direct traffic on this virtual server. The default is tcp. valid options are [any,udp,tcp]
    Irules List<string>
    The iRules list you want run on this virtual server. iRules help automate the intercepting, processing, and routing of application traffic.
    Mask string
    Mask can either be in CIDR notation or decimal, i.e.: 24 or 255.255.255.0. A CIDR mask of 0 is the same as 0.0.0.0
    Name string
    Name of the virtual server
    PerFlowRequestAccessPolicy string
    PersistenceProfiles List<string>
    List of persistence profiles associated with the Virtual Server.
    Policies List<string>
    Specifies the policies for the virtual server.
    Pool string
    Default pool name
    Port int
    Listen port for the virtual server
    Profiles List<string>
    List of profiles associated both client and server contexts on the virtual server. This includes protocol, ssl, http, etc.
    SecurityLogProfiles List<string>
    Specifies the log profile applied to the virtual server.
    ServerProfiles List<string>
    List of server context profiles associated on the virtual server. Not mutually exclusive with profiles and client_profiles
    Snatpool string
    Specifies the name of an existing SNAT pool that you want the virtual server to use to implement selective and intelligent SNATs.
    Source string
    Specifies an IP address or network from which the virtual server will accept traffic.
    SourceAddressTranslation string
    Can be either omitted for none or the values automap options : [snat,automap,none].
    SourcePort string
    Specifies whether the system preserves the source port of the connection. The default is preserve.
    State string
    Specifies whether the virtual server and its resources are available for load balancing. The default is Enabled
    TrafficmatchingCriteria string
    Specifies destination traffic matching information to which the virtual server sends traffic
    TranslateAddress string
    Enables or disables address translation for the virtual server. Turn address translation off for a virtual server if you want to use the virtual server to load balance connections to any address. This option is useful when the system is load balancing devices that have the same IP address.
    TranslatePort string
    Enables or disables port translation. Turn port translation off for a virtual server if you want to use the virtual server to load balance connections to any service
    Vlans List<string>
    The virtual server is enabled/disabled on this set of VLANs,enable/disabled will be desided by attribute vlan_enabled
    VlansEnabled bool
    Enables the virtual server on the VLANs specified by the vlans option. By default it is false i.e vlanDisabled on specified vlans, if we want enable virtual server on VLANs specified by vlans, mark this attribute to true.
    ClientProfiles []string
    List of client context profiles associated on the virtual server. Not mutually exclusive with profiles and server_profiles
    DefaultPersistenceProfile string
    Description string
    Description of Virtual server
    Destination string
    Destination IP
    FallbackPersistenceProfile string
    Specifies a fallback persistence profile for the Virtual Server to use when the default persistence profile is not available.
    FirewallEnforcedPolicy string
    Applies the specified AFM policy to the virtual in an enforcing way,when creating a new virtual, if this parameter is not specified, the enforced is disabled.This should be in full path ex: /Common/afm-test-policy.
    IpProtocol string
    Specifies a network protocol name you want the system to use to direct traffic on this virtual server. The default is tcp. valid options are [any,udp,tcp]
    Irules []string
    The iRules list you want run on this virtual server. iRules help automate the intercepting, processing, and routing of application traffic.
    Mask string
    Mask can either be in CIDR notation or decimal, i.e.: 24 or 255.255.255.0. A CIDR mask of 0 is the same as 0.0.0.0
    Name string
    Name of the virtual server
    PerFlowRequestAccessPolicy string
    PersistenceProfiles []string
    List of persistence profiles associated with the Virtual Server.
    Policies []string
    Specifies the policies for the virtual server.
    Pool string
    Default pool name
    Port int
    Listen port for the virtual server
    Profiles []string
    List of profiles associated both client and server contexts on the virtual server. This includes protocol, ssl, http, etc.
    SecurityLogProfiles []string
    Specifies the log profile applied to the virtual server.
    ServerProfiles []string
    List of server context profiles associated on the virtual server. Not mutually exclusive with profiles and client_profiles
    Snatpool string
    Specifies the name of an existing SNAT pool that you want the virtual server to use to implement selective and intelligent SNATs.
    Source string
    Specifies an IP address or network from which the virtual server will accept traffic.
    SourceAddressTranslation string
    Can be either omitted for none or the values automap options : [snat,automap,none].
    SourcePort string
    Specifies whether the system preserves the source port of the connection. The default is preserve.
    State string
    Specifies whether the virtual server and its resources are available for load balancing. The default is Enabled
    TrafficmatchingCriteria string
    Specifies destination traffic matching information to which the virtual server sends traffic
    TranslateAddress string
    Enables or disables address translation for the virtual server. Turn address translation off for a virtual server if you want to use the virtual server to load balance connections to any address. This option is useful when the system is load balancing devices that have the same IP address.
    TranslatePort string
    Enables or disables port translation. Turn port translation off for a virtual server if you want to use the virtual server to load balance connections to any service
    Vlans []string
    The virtual server is enabled/disabled on this set of VLANs,enable/disabled will be desided by attribute vlan_enabled
    VlansEnabled bool
    Enables the virtual server on the VLANs specified by the vlans option. By default it is false i.e vlanDisabled on specified vlans, if we want enable virtual server on VLANs specified by vlans, mark this attribute to true.
    clientProfiles List<String>
    List of client context profiles associated on the virtual server. Not mutually exclusive with profiles and server_profiles
    defaultPersistenceProfile String
    description String
    Description of Virtual server
    destination String
    Destination IP
    fallbackPersistenceProfile String
    Specifies a fallback persistence profile for the Virtual Server to use when the default persistence profile is not available.
    firewallEnforcedPolicy String
    Applies the specified AFM policy to the virtual in an enforcing way,when creating a new virtual, if this parameter is not specified, the enforced is disabled.This should be in full path ex: /Common/afm-test-policy.
    ipProtocol String
    Specifies a network protocol name you want the system to use to direct traffic on this virtual server. The default is tcp. valid options are [any,udp,tcp]
    irules List<String>
    The iRules list you want run on this virtual server. iRules help automate the intercepting, processing, and routing of application traffic.
    mask String
    Mask can either be in CIDR notation or decimal, i.e.: 24 or 255.255.255.0. A CIDR mask of 0 is the same as 0.0.0.0
    name String
    Name of the virtual server
    perFlowRequestAccessPolicy String
    persistenceProfiles List<String>
    List of persistence profiles associated with the Virtual Server.
    policies List<String>
    Specifies the policies for the virtual server.
    pool String
    Default pool name
    port Integer
    Listen port for the virtual server
    profiles List<String>
    List of profiles associated both client and server contexts on the virtual server. This includes protocol, ssl, http, etc.
    securityLogProfiles List<String>
    Specifies the log profile applied to the virtual server.
    serverProfiles List<String>
    List of server context profiles associated on the virtual server. Not mutually exclusive with profiles and client_profiles
    snatpool String
    Specifies the name of an existing SNAT pool that you want the virtual server to use to implement selective and intelligent SNATs.
    source String
    Specifies an IP address or network from which the virtual server will accept traffic.
    sourceAddressTranslation String
    Can be either omitted for none or the values automap options : [snat,automap,none].
    sourcePort String
    Specifies whether the system preserves the source port of the connection. The default is preserve.
    state String
    Specifies whether the virtual server and its resources are available for load balancing. The default is Enabled
    trafficmatchingCriteria String
    Specifies destination traffic matching information to which the virtual server sends traffic
    translateAddress String
    Enables or disables address translation for the virtual server. Turn address translation off for a virtual server if you want to use the virtual server to load balance connections to any address. This option is useful when the system is load balancing devices that have the same IP address.
    translatePort String
    Enables or disables port translation. Turn port translation off for a virtual server if you want to use the virtual server to load balance connections to any service
    vlans List<String>
    The virtual server is enabled/disabled on this set of VLANs,enable/disabled will be desided by attribute vlan_enabled
    vlansEnabled Boolean
    Enables the virtual server on the VLANs specified by the vlans option. By default it is false i.e vlanDisabled on specified vlans, if we want enable virtual server on VLANs specified by vlans, mark this attribute to true.
    clientProfiles string[]
    List of client context profiles associated on the virtual server. Not mutually exclusive with profiles and server_profiles
    defaultPersistenceProfile string
    description string
    Description of Virtual server
    destination string
    Destination IP
    fallbackPersistenceProfile string
    Specifies a fallback persistence profile for the Virtual Server to use when the default persistence profile is not available.
    firewallEnforcedPolicy string
    Applies the specified AFM policy to the virtual in an enforcing way,when creating a new virtual, if this parameter is not specified, the enforced is disabled.This should be in full path ex: /Common/afm-test-policy.
    ipProtocol string
    Specifies a network protocol name you want the system to use to direct traffic on this virtual server. The default is tcp. valid options are [any,udp,tcp]
    irules string[]
    The iRules list you want run on this virtual server. iRules help automate the intercepting, processing, and routing of application traffic.
    mask string
    Mask can either be in CIDR notation or decimal, i.e.: 24 or 255.255.255.0. A CIDR mask of 0 is the same as 0.0.0.0
    name string
    Name of the virtual server
    perFlowRequestAccessPolicy string
    persistenceProfiles string[]
    List of persistence profiles associated with the Virtual Server.
    policies string[]
    Specifies the policies for the virtual server.
    pool string
    Default pool name
    port number
    Listen port for the virtual server
    profiles string[]
    List of profiles associated both client and server contexts on the virtual server. This includes protocol, ssl, http, etc.
    securityLogProfiles string[]
    Specifies the log profile applied to the virtual server.
    serverProfiles string[]
    List of server context profiles associated on the virtual server. Not mutually exclusive with profiles and client_profiles
    snatpool string
    Specifies the name of an existing SNAT pool that you want the virtual server to use to implement selective and intelligent SNATs.
    source string
    Specifies an IP address or network from which the virtual server will accept traffic.
    sourceAddressTranslation string
    Can be either omitted for none or the values automap options : [snat,automap,none].
    sourcePort string
    Specifies whether the system preserves the source port of the connection. The default is preserve.
    state string
    Specifies whether the virtual server and its resources are available for load balancing. The default is Enabled
    trafficmatchingCriteria string
    Specifies destination traffic matching information to which the virtual server sends traffic
    translateAddress string
    Enables or disables address translation for the virtual server. Turn address translation off for a virtual server if you want to use the virtual server to load balance connections to any address. This option is useful when the system is load balancing devices that have the same IP address.
    translatePort string
    Enables or disables port translation. Turn port translation off for a virtual server if you want to use the virtual server to load balance connections to any service
    vlans string[]
    The virtual server is enabled/disabled on this set of VLANs,enable/disabled will be desided by attribute vlan_enabled
    vlansEnabled boolean
    Enables the virtual server on the VLANs specified by the vlans option. By default it is false i.e vlanDisabled on specified vlans, if we want enable virtual server on VLANs specified by vlans, mark this attribute to true.
    client_profiles Sequence[str]
    List of client context profiles associated on the virtual server. Not mutually exclusive with profiles and server_profiles
    default_persistence_profile str
    description str
    Description of Virtual server
    destination str
    Destination IP
    fallback_persistence_profile str
    Specifies a fallback persistence profile for the Virtual Server to use when the default persistence profile is not available.
    firewall_enforced_policy str
    Applies the specified AFM policy to the virtual in an enforcing way,when creating a new virtual, if this parameter is not specified, the enforced is disabled.This should be in full path ex: /Common/afm-test-policy.
    ip_protocol str
    Specifies a network protocol name you want the system to use to direct traffic on this virtual server. The default is tcp. valid options are [any,udp,tcp]
    irules Sequence[str]
    The iRules list you want run on this virtual server. iRules help automate the intercepting, processing, and routing of application traffic.
    mask str
    Mask can either be in CIDR notation or decimal, i.e.: 24 or 255.255.255.0. A CIDR mask of 0 is the same as 0.0.0.0
    name str
    Name of the virtual server
    per_flow_request_access_policy str
    persistence_profiles Sequence[str]
    List of persistence profiles associated with the Virtual Server.
    policies Sequence[str]
    Specifies the policies for the virtual server.
    pool str
    Default pool name
    port int
    Listen port for the virtual server
    profiles Sequence[str]
    List of profiles associated both client and server contexts on the virtual server. This includes protocol, ssl, http, etc.
    security_log_profiles Sequence[str]
    Specifies the log profile applied to the virtual server.
    server_profiles Sequence[str]
    List of server context profiles associated on the virtual server. Not mutually exclusive with profiles and client_profiles
    snatpool str
    Specifies the name of an existing SNAT pool that you want the virtual server to use to implement selective and intelligent SNATs.
    source str
    Specifies an IP address or network from which the virtual server will accept traffic.
    source_address_translation str
    Can be either omitted for none or the values automap options : [snat,automap,none].
    source_port str
    Specifies whether the system preserves the source port of the connection. The default is preserve.
    state str
    Specifies whether the virtual server and its resources are available for load balancing. The default is Enabled
    trafficmatching_criteria str
    Specifies destination traffic matching information to which the virtual server sends traffic
    translate_address str
    Enables or disables address translation for the virtual server. Turn address translation off for a virtual server if you want to use the virtual server to load balance connections to any address. This option is useful when the system is load balancing devices that have the same IP address.
    translate_port str
    Enables or disables port translation. Turn port translation off for a virtual server if you want to use the virtual server to load balance connections to any service
    vlans Sequence[str]
    The virtual server is enabled/disabled on this set of VLANs,enable/disabled will be desided by attribute vlan_enabled
    vlans_enabled bool
    Enables the virtual server on the VLANs specified by the vlans option. By default it is false i.e vlanDisabled on specified vlans, if we want enable virtual server on VLANs specified by vlans, mark this attribute to true.
    clientProfiles List<String>
    List of client context profiles associated on the virtual server. Not mutually exclusive with profiles and server_profiles
    defaultPersistenceProfile String
    description String
    Description of Virtual server
    destination String
    Destination IP
    fallbackPersistenceProfile String
    Specifies a fallback persistence profile for the Virtual Server to use when the default persistence profile is not available.
    firewallEnforcedPolicy String
    Applies the specified AFM policy to the virtual in an enforcing way,when creating a new virtual, if this parameter is not specified, the enforced is disabled.This should be in full path ex: /Common/afm-test-policy.
    ipProtocol String
    Specifies a network protocol name you want the system to use to direct traffic on this virtual server. The default is tcp. valid options are [any,udp,tcp]
    irules List<String>
    The iRules list you want run on this virtual server. iRules help automate the intercepting, processing, and routing of application traffic.
    mask String
    Mask can either be in CIDR notation or decimal, i.e.: 24 or 255.255.255.0. A CIDR mask of 0 is the same as 0.0.0.0
    name String
    Name of the virtual server
    perFlowRequestAccessPolicy String
    persistenceProfiles List<String>
    List of persistence profiles associated with the Virtual Server.
    policies List<String>
    Specifies the policies for the virtual server.
    pool String
    Default pool name
    port Number
    Listen port for the virtual server
    profiles List<String>
    List of profiles associated both client and server contexts on the virtual server. This includes protocol, ssl, http, etc.
    securityLogProfiles List<String>
    Specifies the log profile applied to the virtual server.
    serverProfiles List<String>
    List of server context profiles associated on the virtual server. Not mutually exclusive with profiles and client_profiles
    snatpool String
    Specifies the name of an existing SNAT pool that you want the virtual server to use to implement selective and intelligent SNATs.
    source String
    Specifies an IP address or network from which the virtual server will accept traffic.
    sourceAddressTranslation String
    Can be either omitted for none or the values automap options : [snat,automap,none].
    sourcePort String
    Specifies whether the system preserves the source port of the connection. The default is preserve.
    state String
    Specifies whether the virtual server and its resources are available for load balancing. The default is Enabled
    trafficmatchingCriteria String
    Specifies destination traffic matching information to which the virtual server sends traffic
    translateAddress String
    Enables or disables address translation for the virtual server. Turn address translation off for a virtual server if you want to use the virtual server to load balance connections to any address. This option is useful when the system is load balancing devices that have the same IP address.
    translatePort String
    Enables or disables port translation. Turn port translation off for a virtual server if you want to use the virtual server to load balance connections to any service
    vlans List<String>
    The virtual server is enabled/disabled on this set of VLANs,enable/disabled will be desided by attribute vlan_enabled
    vlansEnabled Boolean
    Enables the virtual server on the VLANs specified by the vlans option. By default it is false i.e vlanDisabled on specified vlans, if we want enable virtual server on VLANs specified by vlans, mark this attribute to true.

    Import

    ing

    An existing virtual-server can be imported into this resource by supplying virtual-server Name in full path as id. An example is below:

    $ terraform import bigip_ltm_virtual_server.http /Common/terraform_vs_http

    To learn more about importing existing cloud resources, see Importing resources.

    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