1. Packages
  2. Nutanix
  3. API Docs
  4. getVpc
Nutanix v0.5.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg

nutanix.getVpc

Explore with Pulumi AI

nutanix logo
Nutanix v0.5.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg

    Provides a datasource to retrieve VPC with vpc_uuid or vpc_name .

    Using getVpc

    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 getVpc(args: GetVpcArgs, opts?: InvokeOptions): Promise<GetVpcResult>
    function getVpcOutput(args: GetVpcOutputArgs, opts?: InvokeOptions): Output<GetVpcResult>
    def get_vpc(vpc_name: Optional[str] = None,
                vpc_uuid: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetVpcResult
    def get_vpc_output(vpc_name: Optional[pulumi.Input[str]] = None,
                vpc_uuid: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetVpcResult]
    func LookupVpc(ctx *Context, args *LookupVpcArgs, opts ...InvokeOption) (*LookupVpcResult, error)
    func LookupVpcOutput(ctx *Context, args *LookupVpcOutputArgs, opts ...InvokeOption) LookupVpcResultOutput

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

    public static class GetVpc 
    {
        public static Task<GetVpcResult> InvokeAsync(GetVpcArgs args, InvokeOptions? opts = null)
        public static Output<GetVpcResult> Invoke(GetVpcInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVpcResult> getVpc(GetVpcArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: nutanix:index/getVpc:getVpc
      arguments:
        # arguments dictionary

    The following arguments are supported:

    VpcName string
    vpc Name
    VpcUuid string
    vpc UUID
    VpcName string
    vpc Name
    VpcUuid string
    vpc UUID
    vpcName String
    vpc Name
    vpcUuid String
    vpc UUID
    vpcName string
    vpc Name
    vpcUuid string
    vpc UUID
    vpc_name str
    vpc Name
    vpc_uuid str
    vpc UUID
    vpcName String
    vpc Name
    vpcUuid String
    vpc UUID

    getVpc Result

    The following output properties are available:

    ApiVersion string
    The version of the API.
    Id string
    The provider-assigned unique ID for this managed resource.
    Metadata Dictionary<string, string>
    • The vpc kind metadata.
    Specs List<PiersKarsenbarg.Nutanix.Outputs.GetVpcSpec>
    VPC input spec
    Statuses List<PiersKarsenbarg.Nutanix.Outputs.GetVpcStatus>
    VPC output status
    VpcName string
    VpcUuid string
    ApiVersion string
    The version of the API.
    Id string
    The provider-assigned unique ID for this managed resource.
    Metadata map[string]string
    • The vpc kind metadata.
    Specs []GetVpcSpec
    VPC input spec
    Statuses []GetVpcStatus
    VPC output status
    VpcName string
    VpcUuid string
    apiVersion String
    The version of the API.
    id String
    The provider-assigned unique ID for this managed resource.
    metadata Map<String,String>
    • The vpc kind metadata.
    specs List<GetVpcSpec>
    VPC input spec
    statuses List<GetVpcStatus>
    VPC output status
    vpcName String
    vpcUuid String
    apiVersion string
    The version of the API.
    id string
    The provider-assigned unique ID for this managed resource.
    metadata {[key: string]: string}
    • The vpc kind metadata.
    specs GetVpcSpec[]
    VPC input spec
    statuses GetVpcStatus[]
    VPC output status
    vpcName string
    vpcUuid string
    api_version str
    The version of the API.
    id str
    The provider-assigned unique ID for this managed resource.
    metadata Mapping[str, str]
    • The vpc kind metadata.
    specs Sequence[GetVpcSpec]
    VPC input spec
    statuses Sequence[GetVpcStatus]
    VPC output status
    vpc_name str
    vpc_uuid str
    apiVersion String
    The version of the API.
    id String
    The provider-assigned unique ID for this managed resource.
    metadata Map<String>
    • The vpc kind metadata.
    specs List<Property Map>
    VPC input spec
    statuses List<Property Map>
    VPC output status
    vpcName String
    vpcUuid String

    Supporting Types

    GetVpcSpec

    Name string
    • the name.
    Resources []GetVpcSpecResource
    VPC resources status
    name String
    • the name.
    resources List<GetVpcSpecResource>
    VPC resources status
    name string
    • the name.
    resources GetVpcSpecResource[]
    VPC resources status
    name str
    • the name.
    resources Sequence[GetVpcSpecResource]
    VPC resources status
    name String
    • the name.
    resources List<Property Map>
    VPC resources status

    GetVpcSpecResource

    commonDomainNameServerIpLists List<Property Map>
    List of domain name server IPs.
    externalSubnetLists List<Property Map>
    List of external subnets attached to this VPC.
    externallyRoutablePrefixLists List<Property Map>
    List of external routable ip and prefix .

    GetVpcSpecResourceCommonDomainNameServerIpList

    Ip string
    ip address of domain name server.
    Ip string
    ip address of domain name server.
    ip String
    ip address of domain name server.
    ip string
    ip address of domain name server.
    ip str
    ip address of domain name server.
    ip String
    ip address of domain name server.

    GetVpcSpecResourceExternalSubnetList

    ExternalSubnetReference Dictionary<string, string>
    Reference to a subnet.
    ExternalSubnetReference map[string]string
    Reference to a subnet.
    externalSubnetReference Map<String,String>
    Reference to a subnet.
    externalSubnetReference {[key: string]: string}
    Reference to a subnet.
    external_subnet_reference Mapping[str, str]
    Reference to a subnet.
    externalSubnetReference Map<String>
    Reference to a subnet.

    GetVpcSpecResourceExternallyRoutablePrefixList

    Ip string
    ip address of domain name server.
    PrefixLength int
    prefix length of routable ip .
    Ip string
    ip address of domain name server.
    PrefixLength int
    prefix length of routable ip .
    ip String
    ip address of domain name server.
    prefixLength Integer
    prefix length of routable ip .
    ip string
    ip address of domain name server.
    prefixLength number
    prefix length of routable ip .
    ip str
    ip address of domain name server.
    prefix_length int
    prefix length of routable ip .
    ip String
    ip address of domain name server.
    prefixLength Number
    prefix length of routable ip .

    GetVpcStatus

    ExecutionContexts []GetVpcStatusExecutionContext
    Execution Context of VPC.
    Name string
    • the name.
    Resources []GetVpcStatusResource
    VPC resources status
    State string
    The state of the VPC
    executionContexts List<GetVpcStatusExecutionContext>
    Execution Context of VPC.
    name String
    • the name.
    resources List<GetVpcStatusResource>
    VPC resources status
    state String
    The state of the VPC
    executionContexts GetVpcStatusExecutionContext[]
    Execution Context of VPC.
    name string
    • the name.
    resources GetVpcStatusResource[]
    VPC resources status
    state string
    The state of the VPC
    execution_contexts Sequence[GetVpcStatusExecutionContext]
    Execution Context of VPC.
    name str
    • the name.
    resources Sequence[GetVpcStatusResource]
    VPC resources status
    state str
    The state of the VPC
    executionContexts List<Property Map>
    Execution Context of VPC.
    name String
    • the name.
    resources List<Property Map>
    VPC resources status
    state String
    The state of the VPC

    GetVpcStatusExecutionContext

    TaskUuids List<string>
    TaskUuids []string
    taskUuids List<String>
    taskUuids string[]
    task_uuids Sequence[str]
    taskUuids List<String>

    GetVpcStatusResource

    commonDomainNameServerIpLists List<Property Map>
    List of domain name server IPs.
    externalSubnetLists List<Property Map>
    List of external subnets attached to this VPC.
    externallyRoutablePrefixLists List<Property Map>
    List of external routable ip and prefix .

    GetVpcStatusResourceCommonDomainNameServerIpList

    Ip string
    ip address of domain name server.
    Ip string
    ip address of domain name server.
    ip String
    ip address of domain name server.
    ip string
    ip address of domain name server.
    ip str
    ip address of domain name server.
    ip String
    ip address of domain name server.

    GetVpcStatusResourceExternalSubnetList

    ActiveGatewayNodes List<PiersKarsenbarg.Nutanix.Inputs.GetVpcStatusResourceExternalSubnetListActiveGatewayNode>
    Active Gateway Node. Only present in VPC Status Resources.
    ExternalIpLists List<string>
    List of external subnets attached to this VPC. Only present in VPC Status Resources .
    ExternalSubnetReference Dictionary<string, string>
    Reference to a subnet.
    ActiveGatewayNodes []GetVpcStatusResourceExternalSubnetListActiveGatewayNode
    Active Gateway Node. Only present in VPC Status Resources.
    ExternalIpLists []string
    List of external subnets attached to this VPC. Only present in VPC Status Resources .
    ExternalSubnetReference map[string]string
    Reference to a subnet.
    activeGatewayNodes List<GetVpcStatusResourceExternalSubnetListActiveGatewayNode>
    Active Gateway Node. Only present in VPC Status Resources.
    externalIpLists List<String>
    List of external subnets attached to this VPC. Only present in VPC Status Resources .
    externalSubnetReference Map<String,String>
    Reference to a subnet.
    activeGatewayNodes GetVpcStatusResourceExternalSubnetListActiveGatewayNode[]
    Active Gateway Node. Only present in VPC Status Resources.
    externalIpLists string[]
    List of external subnets attached to this VPC. Only present in VPC Status Resources .
    externalSubnetReference {[key: string]: string}
    Reference to a subnet.
    active_gateway_nodes Sequence[GetVpcStatusResourceExternalSubnetListActiveGatewayNode]
    Active Gateway Node. Only present in VPC Status Resources.
    external_ip_lists Sequence[str]
    List of external subnets attached to this VPC. Only present in VPC Status Resources .
    external_subnet_reference Mapping[str, str]
    Reference to a subnet.
    activeGatewayNodes List<Property Map>
    Active Gateway Node. Only present in VPC Status Resources.
    externalIpLists List<String>
    List of external subnets attached to this VPC. Only present in VPC Status Resources .
    externalSubnetReference Map<String>
    Reference to a subnet.

    GetVpcStatusResourceExternalSubnetListActiveGatewayNode

    HostReference Dictionary<string, string>
    Reference to host.
    IpAddress string
    ip address.
    HostReference map[string]string
    Reference to host.
    IpAddress string
    ip address.
    hostReference Map<String,String>
    Reference to host.
    ipAddress String
    ip address.
    hostReference {[key: string]: string}
    Reference to host.
    ipAddress string
    ip address.
    host_reference Mapping[str, str]
    Reference to host.
    ip_address str
    ip address.
    hostReference Map<String>
    Reference to host.
    ipAddress String
    ip address.

    GetVpcStatusResourceExternallyRoutablePrefixList

    Ip string
    ip address of domain name server.
    PrefixLength int
    prefix length of routable ip .
    Ip string
    ip address of domain name server.
    PrefixLength int
    prefix length of routable ip .
    ip String
    ip address of domain name server.
    prefixLength Integer
    prefix length of routable ip .
    ip string
    ip address of domain name server.
    prefixLength number
    prefix length of routable ip .
    ip str
    ip address of domain name server.
    prefix_length int
    prefix length of routable ip .
    ip String
    ip address of domain name server.
    prefixLength Number
    prefix length of routable ip .

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Nutanix v0.5.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg