Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Avi Provider
  3. API Docs
  4. getServer
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

avi.getServer

Explore with Pulumi AI

avi logo
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

    This data source is used to to get avi.Server objects.

    Using getServer

    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 getServer(args: GetServerArgs, opts?: InvokeOptions): Promise<GetServerResult>
function getServerOutput(args: GetServerOutputArgs, opts?: InvokeOptions): Output<GetServerResult>
    def get_server(id: Optional[str] = None,
               ip: Optional[str] = None,
               pool_ref: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetServerResult
def get_server_output(id: Optional[pulumi.Input[str]] = None,
               ip: Optional[pulumi.Input[str]] = None,
               pool_ref: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetServerResult]
    func LookupServer(ctx *Context, args *LookupServerArgs, opts ...InvokeOption) (*LookupServerResult, error)
func LookupServerOutput(ctx *Context, args *LookupServerOutputArgs, opts ...InvokeOption) LookupServerResultOutput

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

    public static class GetServer 
{
    public static Task<GetServerResult> InvokeAsync(GetServerArgs args, InvokeOptions? opts = null)
    public static Output<GetServerResult> Invoke(GetServerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)
public static Output<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)

    fn::invoke:
  function: avi:index/getServer:getServer
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Ip string
    Search Server by ip.
    PoolRef string
    Search Server by pool_ref.
    Id string
    Ip string
    Search Server by ip.
    PoolRef string
    Search Server by pool_ref.
    Id string
    ip String
    Search Server by ip.
    poolRef String
    Search Server by pool_ref.
    id String
    ip string
    Search Server by ip.
    poolRef string
    Search Server by pool_ref.
    id string
    ip str
    Search Server by ip.
    pool_ref str
    Search Server by pool_ref.
    id str
    ip String
    Search Server by ip.
    poolRef String
    Search Server by pool_ref.
    id String

    getServer Result

    The following output properties are available:

    AutoscalingGroupName string
    Name of autoscaling group this server belongs to.
    AvailabilityZone string
    Description string
    A description of the server.
    DiscoveredNetworks List<GetServerDiscoveredNetwork>
    Enabled string
    Enable or disable the server.
    ExternalOrchestrationId string
    UID of server in external orchestration systems.
    ExternalUuid string
    UUID identifying VM in OpenStack and other external compute.
    HealthMonitorRefs List<string>
    Hostname string
    DNS resolvable name of the server. May be used in place of the IP address.
    Id string
    Ip string
    IP address of a destination servers.
    Locations List<GetServerLocation>
    Geographic location of the server.Currently only for internal usage.
    MacAddress string
    NwRef string
    This field is used internally by Avi, not editable by the user. It is a reference to an object of type VIMgrNWRuntime.
    PoolRef string
    The pool is an object that contains destination servers and related attributes such as load-balancing and persistence.
    Port string
    Port of a destination servers.
    PreferenceOrder string
    PrstHdrVal string
    Header value for custom header persistence.
    Ratio string
    ResolveServerByDns string
    RewriteHostHeader string
    Rewrite incoming Host Header to server name.
    ServerNode string
    SrvRdatas List<GetServerSrvRdata>
    Static string
    Type string
    Type of ip address (V4)
    VerifyNetwork string
    VmRef string
    This field is used internally by Avi, not editable by the user. It is a reference to an object of type VIMgrVMRuntime.
    AutoscalingGroupName string
    Name of autoscaling group this server belongs to.
    AvailabilityZone string
    Description string
    A description of the server.
    DiscoveredNetworks []GetServerDiscoveredNetwork
    Enabled string
    Enable or disable the server.
    ExternalOrchestrationId string
    UID of server in external orchestration systems.
    ExternalUuid string
    UUID identifying VM in OpenStack and other external compute.
    HealthMonitorRefs []string
    Hostname string
    DNS resolvable name of the server. May be used in place of the IP address.
    Id string
    Ip string
    IP address of a destination servers.
    Locations []GetServerLocation
    Geographic location of the server.Currently only for internal usage.
    MacAddress string
    NwRef string
    This field is used internally by Avi, not editable by the user. It is a reference to an object of type VIMgrNWRuntime.
    PoolRef string
    The pool is an object that contains destination servers and related attributes such as load-balancing and persistence.
    Port string
    Port of a destination servers.
    PreferenceOrder string
    PrstHdrVal string
    Header value for custom header persistence.
    Ratio string
    ResolveServerByDns string
    RewriteHostHeader string
    Rewrite incoming Host Header to server name.
    ServerNode string
    SrvRdatas []GetServerSrvRdata
    Static string
    Type string
    Type of ip address (V4)
    VerifyNetwork string
    VmRef string
    This field is used internally by Avi, not editable by the user. It is a reference to an object of type VIMgrVMRuntime.
    autoscalingGroupName String
    Name of autoscaling group this server belongs to.
    availabilityZone String
    description String
    A description of the server.
    discoveredNetworks List<GetServerDiscoveredNetwork>
    enabled String
    Enable or disable the server.
    externalOrchestrationId String
    UID of server in external orchestration systems.
    externalUuid String
    UUID identifying VM in OpenStack and other external compute.
    healthMonitorRefs List<String>
    hostname String
    DNS resolvable name of the server. May be used in place of the IP address.
    id String
    ip String
    IP address of a destination servers.
    locations List<GetServerLocation>
    Geographic location of the server.Currently only for internal usage.
    macAddress String
    nwRef String
    This field is used internally by Avi, not editable by the user. It is a reference to an object of type VIMgrNWRuntime.
    poolRef String
    The pool is an object that contains destination servers and related attributes such as load-balancing and persistence.
    port String
    Port of a destination servers.
    preferenceOrder String
    prstHdrVal String
    Header value for custom header persistence.
    ratio String
    resolveServerByDns String
    rewriteHostHeader String
    Rewrite incoming Host Header to server name.
    serverNode String
    srvRdatas List<GetServerSrvRdata>
    static_ String
    type String
    Type of ip address (V4)
    verifyNetwork String
    vmRef String
    This field is used internally by Avi, not editable by the user. It is a reference to an object of type VIMgrVMRuntime.
    autoscalingGroupName string
    Name of autoscaling group this server belongs to.
    availabilityZone string
    description string
    A description of the server.
    discoveredNetworks GetServerDiscoveredNetwork[]
    enabled string
    Enable or disable the server.
    externalOrchestrationId string
    UID of server in external orchestration systems.
    externalUuid string
    UUID identifying VM in OpenStack and other external compute.
    healthMonitorRefs string[]
    hostname string
    DNS resolvable name of the server. May be used in place of the IP address.
    id string
    ip string
    IP address of a destination servers.
    locations GetServerLocation[]
    Geographic location of the server.Currently only for internal usage.
    macAddress string
    nwRef string
    This field is used internally by Avi, not editable by the user. It is a reference to an object of type VIMgrNWRuntime.
    poolRef string
    The pool is an object that contains destination servers and related attributes such as load-balancing and persistence.
    port string
    Port of a destination servers.
    preferenceOrder string
    prstHdrVal string
    Header value for custom header persistence.
    ratio string
    resolveServerByDns string
    rewriteHostHeader string
    Rewrite incoming Host Header to server name.
    serverNode string
    srvRdatas GetServerSrvRdata[]
    static string
    type string
    Type of ip address (V4)
    verifyNetwork string
    vmRef string
    This field is used internally by Avi, not editable by the user. It is a reference to an object of type VIMgrVMRuntime.
    autoscaling_group_name str
    Name of autoscaling group this server belongs to.
    availability_zone str
    description str
    A description of the server.
    discovered_networks Sequence[GetServerDiscoveredNetwork]
    enabled str
    Enable or disable the server.
    external_orchestration_id str
    UID of server in external orchestration systems.
    external_uuid str
    UUID identifying VM in OpenStack and other external compute.
    health_monitor_refs Sequence[str]
    hostname str
    DNS resolvable name of the server. May be used in place of the IP address.
    id str
    ip str
    IP address of a destination servers.
    locations Sequence[GetServerLocation]
    Geographic location of the server.Currently only for internal usage.
    mac_address str
    nw_ref str
    This field is used internally by Avi, not editable by the user. It is a reference to an object of type VIMgrNWRuntime.
    pool_ref str
    The pool is an object that contains destination servers and related attributes such as load-balancing and persistence.
    port str
    Port of a destination servers.
    preference_order str
    prst_hdr_val str
    Header value for custom header persistence.
    ratio str
    resolve_server_by_dns str
    rewrite_host_header str
    Rewrite incoming Host Header to server name.
    server_node str
    srv_rdatas Sequence[GetServerSrvRdata]
    static str
    type str
    Type of ip address (V4)
    verify_network str
    vm_ref str
    This field is used internally by Avi, not editable by the user. It is a reference to an object of type VIMgrVMRuntime.
    autoscalingGroupName String
    Name of autoscaling group this server belongs to.
    availabilityZone String
    description String
    A description of the server.
    discoveredNetworks List<Property Map>
    enabled String
    Enable or disable the server.
    externalOrchestrationId String
    UID of server in external orchestration systems.
    externalUuid String
    UUID identifying VM in OpenStack and other external compute.
    healthMonitorRefs List<String>
    hostname String
    DNS resolvable name of the server. May be used in place of the IP address.
    id String
    ip String
    IP address of a destination servers.
    locations List<Property Map>
    Geographic location of the server.Currently only for internal usage.
    macAddress String
    nwRef String
    This field is used internally by Avi, not editable by the user. It is a reference to an object of type VIMgrNWRuntime.
    poolRef String
    The pool is an object that contains destination servers and related attributes such as load-balancing and persistence.
    port String
    Port of a destination servers.
    preferenceOrder String
    prstHdrVal String
    Header value for custom header persistence.
    ratio String
    resolveServerByDns String
    rewriteHostHeader String
    Rewrite incoming Host Header to server name.
    serverNode String
    srvRdatas List<Property Map>
    static String
    type String
    Type of ip address (V4)
    verifyNetwork String
    vmRef String
    This field is used internally by Avi, not editable by the user. It is a reference to an object of type VIMgrVMRuntime.

    Supporting Types

    GetServerDiscoveredNetwork

    GetServerDiscoveredNetworkSubnet

    GetServerDiscoveredNetworkSubnet6

    GetServerDiscoveredNetworkSubnet6IpAddr

    Addr string
    Type string
    Type of ip address (V4)
    Addr string
    Type string
    Type of ip address (V4)
    addr String
    type String
    Type of ip address (V4)
    addr string
    type string
    Type of ip address (V4)
    addr str
    type str
    Type of ip address (V4)
    addr String
    type String
    Type of ip address (V4)

    GetServerDiscoveredNetworkSubnetIpAddr

    Addr string
    Type string
    Type of ip address (V4)
    Addr string
    Type string
    Type of ip address (V4)
    addr String
    type String
    Type of ip address (V4)
    addr string
    type string
    Type of ip address (V4)
    addr str
    type str
    Type of ip address (V4)
    addr String
    type String
    Type of ip address (V4)

    GetServerLocation

    Latitude string
    Longitude string
    Name string
    Tag string
    Latitude string
    Longitude string
    Name string
    Tag string
    latitude String
    longitude String
    name String
    tag String
    latitude string
    longitude string
    name string
    tag string
    latitude str
    longitude str
    name str
    tag str
    latitude String
    longitude String
    name String
    tag String

    GetServerSrvRdata

    Port string
    Port of a destination servers.
    Priority string
    Weight string
    Port string
    Port of a destination servers.
    Priority string
    Weight string
    port String
    Port of a destination servers.
    priority String
    weight String
    port string
    Port of a destination servers.
    priority string
    weight string
    port str
    Port of a destination servers.
    priority str
    weight str
    port String
    Port of a destination servers.
    priority String
    weight String

    Package Details

    Repository
    avi vmware/terraform-provider-avi
    License
    Notes
    This Pulumi package is based on the avi Terraform Provider.
    avi logo
    avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
    vmware/terraform-provider-avi