1. Packages
  2. Packages
  3. Nsxt Provider
  4. API Docs
  5. getProxyConfig
Viewing docs for nsxt 3.12.0
published on Monday, May 18, 2026 by vmware
Viewing docs for nsxt 3.12.0
published on Monday, May 18, 2026 by vmware

    This data source provides information about internet proxy configuration in NSX Manager.

    ℹ️ Singleton Resource: This data source reads global proxy configuration which exists as a single instance per NSX-T environment.

    This data source is applicable to NSX Manager (version 4.2.0 onwards).

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nsxt from "@pulumi/nsxt";
    
    const internetProxy = nsxt.getProxyConfig({});
    export const proxyStatus = {
        enabled: internetProxy.then(internetProxy => internetProxy.enabled),
        host: internetProxy.then(internetProxy => internetProxy.host),
        port: internetProxy.then(internetProxy => internetProxy.port),
        scheme: internetProxy.then(internetProxy => internetProxy.scheme),
    };
    
    import pulumi
    import pulumi_nsxt as nsxt
    
    internet_proxy = nsxt.get_proxy_config()
    pulumi.export("proxyStatus", {
        "enabled": internet_proxy.enabled,
        "host": internet_proxy.host,
        "port": internet_proxy.port,
        "scheme": internet_proxy.scheme,
    })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/nsxt/v3/nsxt"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		internetProxy, err := nsxt.LookupProxyConfig(ctx, &nsxt.LookupProxyConfigArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("proxyStatus", pulumi.Map{
    			"enabled": internetProxy.Enabled,
    			"host":    internetProxy.Host,
    			"port":    internetProxy.Port,
    			"scheme":  internetProxy.Scheme,
    		})
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nsxt = Pulumi.Nsxt;
    
    return await Deployment.RunAsync(() => 
    {
        var internetProxy = Nsxt.GetProxyConfig.Invoke();
    
        return new Dictionary<string, object?>
        {
            ["proxyStatus"] = 
            {
                { "enabled", internetProxy.Apply(getProxyConfigResult => getProxyConfigResult.Enabled) },
                { "host", internetProxy.Apply(getProxyConfigResult => getProxyConfigResult.Host) },
                { "port", internetProxy.Apply(getProxyConfigResult => getProxyConfigResult.Port) },
                { "scheme", internetProxy.Apply(getProxyConfigResult => getProxyConfigResult.Scheme) },
            },
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nsxt.NsxtFunctions;
    import com.pulumi.nsxt.inputs.GetProxyConfigArgs;
    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) {
            final var internetProxy = NsxtFunctions.getProxyConfig(GetProxyConfigArgs.builder()
                .build());
    
            ctx.export("proxyStatus", Map.ofEntries(
                Map.entry("enabled", internetProxy.enabled()),
                Map.entry("host", internetProxy.host()),
                Map.entry("port", internetProxy.port()),
                Map.entry("scheme", internetProxy.scheme())
            ));
        }
    }
    
    variables:
      internetProxy:
        fn::invoke:
          function: nsxt:getProxyConfig
          arguments: {}
    outputs:
      proxyStatus:
        enabled: ${internetProxy.enabled}
        host: ${internetProxy.host}
        port: ${internetProxy.port}
        scheme: ${internetProxy.scheme}
    
    Example coming soon!
    

    Using getProxyConfig

    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 getProxyConfig(args: GetProxyConfigArgs, opts?: InvokeOptions): Promise<GetProxyConfigResult>
    function getProxyConfigOutput(args: GetProxyConfigOutputArgs, opts?: InvokeOptions): Output<GetProxyConfigResult>
    def get_proxy_config(description: Optional[str] = None,
                         display_name: Optional[str] = None,
                         id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetProxyConfigResult
    def get_proxy_config_output(description: pulumi.Input[Optional[str]] = None,
                         display_name: pulumi.Input[Optional[str]] = None,
                         id: pulumi.Input[Optional[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetProxyConfigResult]
    func LookupProxyConfig(ctx *Context, args *LookupProxyConfigArgs, opts ...InvokeOption) (*LookupProxyConfigResult, error)
    func LookupProxyConfigOutput(ctx *Context, args *LookupProxyConfigOutputArgs, opts ...InvokeOption) LookupProxyConfigResultOutput

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

    public static class GetProxyConfig 
    {
        public static Task<GetProxyConfigResult> InvokeAsync(GetProxyConfigArgs args, InvokeOptions? opts = null)
        public static Output<GetProxyConfigResult> Invoke(GetProxyConfigInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetProxyConfigResult> getProxyConfig(GetProxyConfigArgs args, InvokeOptions options)
    public static Output<GetProxyConfigResult> getProxyConfig(GetProxyConfigArgs args, InvokeOptions options)
    
    fn::invoke:
      function: nsxt:index/getProxyConfig:getProxyConfig
      arguments:
        # arguments dictionary
    data "nsxt_getproxyconfig" "name" {
        # arguments
    }

    The following arguments are supported:

    Description string
    Description of the resource.
    DisplayName string
    Display name (managed by NSX).
    Id string
    ID of the proxy configuration.
    Description string
    Description of the resource.
    DisplayName string
    Display name (managed by NSX).
    Id string
    ID of the proxy configuration.
    description string
    Description of the resource.
    display_name string
    Display name (managed by NSX).
    id string
    ID of the proxy configuration.
    description String
    Description of the resource.
    displayName String
    Display name (managed by NSX).
    id String
    ID of the proxy configuration.
    description string
    Description of the resource.
    displayName string
    Display name (managed by NSX).
    id string
    ID of the proxy configuration.
    description str
    Description of the resource.
    display_name str
    Display name (managed by NSX).
    id str
    ID of the proxy configuration.
    description String
    Description of the resource.
    displayName String
    Display name (managed by NSX).
    id String
    ID of the proxy configuration.

    getProxyConfig Result

    The following output properties are available:

    CertificateId string
    Certificate ID for HTTPS proxy.
    Description string
    Description of the resource.
    DisplayName string
    Display name (managed by NSX).
    Enabled bool
    Whether proxy is enabled.
    Host string
    Proxy server host (IP address or FQDN).
    Id string
    ID of the proxy configuration.
    Path string
    NSX path of the resource.
    Port double
    Proxy server port.
    Scheme string
    Proxy scheme (HTTP or HTTPS).
    TestConnectionUrl string
    URL used to test connectivity.
    Username string
    Username for authentication.
    CertificateId string
    Certificate ID for HTTPS proxy.
    Description string
    Description of the resource.
    DisplayName string
    Display name (managed by NSX).
    Enabled bool
    Whether proxy is enabled.
    Host string
    Proxy server host (IP address or FQDN).
    Id string
    ID of the proxy configuration.
    Path string
    NSX path of the resource.
    Port float64
    Proxy server port.
    Scheme string
    Proxy scheme (HTTP or HTTPS).
    TestConnectionUrl string
    URL used to test connectivity.
    Username string
    Username for authentication.
    certificate_id string
    Certificate ID for HTTPS proxy.
    description string
    Description of the resource.
    display_name string
    Display name (managed by NSX).
    enabled bool
    Whether proxy is enabled.
    host string
    Proxy server host (IP address or FQDN).
    id string
    ID of the proxy configuration.
    path string
    NSX path of the resource.
    port number
    Proxy server port.
    scheme string
    Proxy scheme (HTTP or HTTPS).
    test_connection_url string
    URL used to test connectivity.
    username string
    Username for authentication.
    certificateId String
    Certificate ID for HTTPS proxy.
    description String
    Description of the resource.
    displayName String
    Display name (managed by NSX).
    enabled Boolean
    Whether proxy is enabled.
    host String
    Proxy server host (IP address or FQDN).
    id String
    ID of the proxy configuration.
    path String
    NSX path of the resource.
    port Double
    Proxy server port.
    scheme String
    Proxy scheme (HTTP or HTTPS).
    testConnectionUrl String
    URL used to test connectivity.
    username String
    Username for authentication.
    certificateId string
    Certificate ID for HTTPS proxy.
    description string
    Description of the resource.
    displayName string
    Display name (managed by NSX).
    enabled boolean
    Whether proxy is enabled.
    host string
    Proxy server host (IP address or FQDN).
    id string
    ID of the proxy configuration.
    path string
    NSX path of the resource.
    port number
    Proxy server port.
    scheme string
    Proxy scheme (HTTP or HTTPS).
    testConnectionUrl string
    URL used to test connectivity.
    username string
    Username for authentication.
    certificate_id str
    Certificate ID for HTTPS proxy.
    description str
    Description of the resource.
    display_name str
    Display name (managed by NSX).
    enabled bool
    Whether proxy is enabled.
    host str
    Proxy server host (IP address or FQDN).
    id str
    ID of the proxy configuration.
    path str
    NSX path of the resource.
    port float
    Proxy server port.
    scheme str
    Proxy scheme (HTTP or HTTPS).
    test_connection_url str
    URL used to test connectivity.
    username str
    Username for authentication.
    certificateId String
    Certificate ID for HTTPS proxy.
    description String
    Description of the resource.
    displayName String
    Display name (managed by NSX).
    enabled Boolean
    Whether proxy is enabled.
    host String
    Proxy server host (IP address or FQDN).
    id String
    ID of the proxy configuration.
    path String
    NSX path of the resource.
    port Number
    Proxy server port.
    scheme String
    Proxy scheme (HTTP or HTTPS).
    testConnectionUrl String
    URL used to test connectivity.
    username String
    Username for authentication.

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    Viewing docs for nsxt 3.12.0
    published on Monday, May 18, 2026 by vmware

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial