Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Nsxt Provider
  4. API Docs
  5. ProxyConfig
Viewing docs for nsxt 3.12.0
published on Monday, May 18, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-nsxt

nsxt.ProxyConfig

Viewing docs for nsxt 3.12.0
published on Monday, May 18, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-nsxt

    This resource provides a means to configure internet proxy settings in NSX Manager (System > General Settings > Internet Proxy Server).

    ⚠️ Singleton Resource: This resource represents global proxy configuration and should only be declared once per NSX-T environment. The resource uses a fixed ID managed by NSX.

    Deleting this resource disables the proxy configuration in NSX rather than removing it. The configuration persists in NSX. This resource is applicable to NSX Manager (version 4.2.0 onwards).

    Example Usage

    Basic HTTP Proxy (Disabled)

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

const test = new nsxt.ProxyConfig("test", {
    enabled: false,
    scheme: "HTTP",
    host: "proxy.example.com",
    port: 8080,
});

    import pulumi
import pulumi_nsxt as nsxt

test = nsxt.ProxyConfig("test",
    enabled=False,
    scheme="HTTP",
    host="proxy.example.com",
    port=8080)

    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 {
		_, err := nsxt.NewProxyConfig(ctx, "test", &nsxt.ProxyConfigArgs{
			Enabled: pulumi.Bool(false),
			Scheme:  pulumi.String("HTTP"),
			Host:    pulumi.String("proxy.example.com"),
			Port:    pulumi.Float64(8080),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var test = new Nsxt.ProxyConfig("test", new()
    {
        Enabled = false,
        Scheme = "HTTP",
        Host = "proxy.example.com",
        Port = 8080,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nsxt.ProxyConfig;
import com.pulumi.nsxt.ProxyConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new ProxyConfig("test", ProxyConfigArgs.builder()
            .enabled(false)
            .scheme("HTTP")
            .host("proxy.example.com")
            .port(8080.0)
            .build());

    }
}

    resources:
  test:
    type: nsxt:ProxyConfig
    properties:
      enabled: false
      scheme: HTTP
      host: proxy.example.com
      port: 8080

    Example coming soon!

    HTTP Proxy with Authentication

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  internetProxy:
    type: nsxt:ProxyConfig
    name: internet_proxy
    properties:
      enabled: true
      scheme: HTTP
      host: proxy.company.com
      port: 8080
      username: proxyuser
      password: ${proxyPassword}
      testConnectionUrl: https://www.vmware.com
      tag:
        - scope: environment
          tag: production

    Example coming soon!

    HTTPS Proxy with Certificate

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

const proxyCert = nsxt.getPolicyCertificate({
    displayName: "proxy-server-cert",
});
const secureProxy = new nsxt.ProxyConfig("secure_proxy", {
    enabled: true,
    scheme: "HTTPS",
    host: "secure-proxy.company.com",
    port: 3128,
    certificateId: proxyCert.then(proxyCert => proxyCert.id),
    testConnectionUrl: "https://www.vmware.com",
});

    import pulumi
import pulumi_nsxt as nsxt

proxy_cert = nsxt.get_policy_certificate(display_name="proxy-server-cert")
secure_proxy = nsxt.ProxyConfig("secure_proxy",
    enabled=True,
    scheme="HTTPS",
    host="secure-proxy.company.com",
    port=3128,
    certificate_id=proxy_cert.id,
    test_connection_url="https://www.vmware.com")

    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 {
		proxyCert, err := nsxt.GetPolicyCertificate(ctx, &nsxt.GetPolicyCertificateArgs{
			DisplayName: pulumi.StringRef("proxy-server-cert"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = nsxt.NewProxyConfig(ctx, "secure_proxy", &nsxt.ProxyConfigArgs{
			Enabled:           pulumi.Bool(true),
			Scheme:            pulumi.String("HTTPS"),
			Host:              pulumi.String("secure-proxy.company.com"),
			Port:              pulumi.Float64(3128),
			CertificateId:     pulumi.String(proxyCert.Id),
			TestConnectionUrl: pulumi.String("https://www.vmware.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var proxyCert = Nsxt.GetPolicyCertificate.Invoke(new()
    {
        DisplayName = "proxy-server-cert",
    });

    var secureProxy = new Nsxt.ProxyConfig("secure_proxy", new()
    {
        Enabled = true,
        Scheme = "HTTPS",
        Host = "secure-proxy.company.com",
        Port = 3128,
        CertificateId = proxyCert.Apply(getPolicyCertificateResult => getPolicyCertificateResult.Id),
        TestConnectionUrl = "https://www.vmware.com",
    });

});

    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.GetPolicyCertificateArgs;
import com.pulumi.nsxt.ProxyConfig;
import com.pulumi.nsxt.ProxyConfigArgs;
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 proxyCert = NsxtFunctions.getPolicyCertificate(GetPolicyCertificateArgs.builder()
            .displayName("proxy-server-cert")
            .build());

        var secureProxy = new ProxyConfig("secureProxy", ProxyConfigArgs.builder()
            .enabled(true)
            .scheme("HTTPS")
            .host("secure-proxy.company.com")
            .port(3128.0)
            .certificateId(proxyCert.id())
            .testConnectionUrl("https://www.vmware.com")
            .build());

    }
}

    resources:
  secureProxy:
    type: nsxt:ProxyConfig
    name: secure_proxy
    properties:
      enabled: true
      scheme: HTTPS
      host: secure-proxy.company.com
      port: 3128
      certificateId: ${proxyCert.id}
      testConnectionUrl: https://www.vmware.com
variables:
  proxyCert:
    fn::invoke:
      function: nsxt:getPolicyCertificate
      arguments:
        displayName: proxy-server-cert

    Example coming soon!

    Create ProxyConfig Resource

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

    Constructor syntax

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

@overload
def ProxyConfig(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                certificate_id: Optional[str] = None,
                description: Optional[str] = None,
                enabled: Optional[bool] = None,
                host: Optional[str] = None,
                nsx_id: Optional[str] = None,
                password: Optional[str] = None,
                port: Optional[float] = None,
                proxy_config_id: Optional[str] = None,
                scheme: Optional[str] = None,
                test_connection_url: Optional[str] = None,
                username: Optional[str] = None)
    func NewProxyConfig(ctx *Context, name string, args *ProxyConfigArgs, opts ...ResourceOption) (*ProxyConfig, error)
    public ProxyConfig(string name, ProxyConfigArgs? args = null, CustomResourceOptions? opts = null)
    public ProxyConfig(String name, ProxyConfigArgs args)
public ProxyConfig(String name, ProxyConfigArgs args, CustomResourceOptions options)

    type: nsxt:ProxyConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "nsxt_proxyconfig" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ProxyConfigArgs
    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 ProxyConfigArgs
    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 ProxyConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProxyConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProxyConfigArgs
    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 proxyConfigResource = new Nsxt.ProxyConfig("proxyConfigResource", new()
{
    CertificateId = "string",
    Description = "string",
    Enabled = false,
    Host = "string",
    NsxId = "string",
    Password = "string",
    Port = 0,
    ProxyConfigId = "string",
    Scheme = "string",
    TestConnectionUrl = "string",
    Username = "string",
});

    example, err := nsxt.NewProxyConfig(ctx, "proxyConfigResource", &nsxt.ProxyConfigArgs{
	CertificateId:     pulumi.String("string"),
	Description:       pulumi.String("string"),
	Enabled:           pulumi.Bool(false),
	Host:              pulumi.String("string"),
	NsxId:             pulumi.String("string"),
	Password:          pulumi.String("string"),
	Port:              pulumi.Float64(0),
	ProxyConfigId:     pulumi.String("string"),
	Scheme:            pulumi.String("string"),
	TestConnectionUrl: pulumi.String("string"),
	Username:          pulumi.String("string"),
})

    resource "nsxt_proxyconfig" "proxyConfigResource" {
  certificate_id      = "string"
  description         = "string"
  enabled             = false
  host                = "string"
  nsx_id              = "string"
  password            = "string"
  port                = 0
  proxy_config_id     = "string"
  scheme              = "string"
  test_connection_url = "string"
  username            = "string"
}

    var proxyConfigResource = new ProxyConfig("proxyConfigResource", ProxyConfigArgs.builder()
    .certificateId("string")
    .description("string")
    .enabled(false)
    .host("string")
    .nsxId("string")
    .password("string")
    .port(0.0)
    .proxyConfigId("string")
    .scheme("string")
    .testConnectionUrl("string")
    .username("string")
    .build());

    proxy_config_resource = nsxt.ProxyConfig("proxyConfigResource",
    certificate_id="string",
    description="string",
    enabled=False,
    host="string",
    nsx_id="string",
    password="string",
    port=float(0),
    proxy_config_id="string",
    scheme="string",
    test_connection_url="string",
    username="string")

    const proxyConfigResource = new nsxt.ProxyConfig("proxyConfigResource", {
    certificateId: "string",
    description: "string",
    enabled: false,
    host: "string",
    nsxId: "string",
    password: "string",
    port: 0,
    proxyConfigId: "string",
    scheme: "string",
    testConnectionUrl: "string",
    username: "string",
});

    type: nsxt:ProxyConfig
properties:
    certificateId: string
    description: string
    enabled: false
    host: string
    nsxId: string
    password: string
    port: 0
    proxyConfigId: string
    scheme: string
    testConnectionUrl: string
    username: string

    ProxyConfig Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ProxyConfig resource accepts the following input properties:

    CertificateId string
    Certificate ID for HTTPS proxy (from trust-management API). Required when scheme is HTTPS.
    Description string
    Description (not supported by NSX for proxy config).
    Enabled bool
    Enable proxy configuration. Default is false. When enabled is set to true, NSX validates connectivity to the proxy server. The test will fail if the proxy is unreachable.
    Host string
    Proxy server host (IP address or FQDN). Required when enabled is true.
    NsxId string
    NSX ID of the proxy configuration.
    Password string
    Password for proxy authentication. This field is sensitive. The password is write-only and not returned by the NSX API. It won't appear in state refresh operations.
    Port double
    Proxy server port. Default is 3128. Valid range: 1-65535.
    ProxyConfigId string
    ID of the proxy configuration (always "TelemetryConfigIdentifier").
    Scheme string
    Proxy scheme. Valid values are HTTP and HTTPS. Default is HTTP. When using HTTPS scheme, you may need to provide a certificate_id. The certificate must be imported to NSX trust management first.
    TestConnectionUrl string
    URL to test proxy connectivity. Default is https://www.vmware.com.
    Username string
    Username for proxy authentication.
    CertificateId string
    Certificate ID for HTTPS proxy (from trust-management API). Required when scheme is HTTPS.
    Description string
    Description (not supported by NSX for proxy config).
    Enabled bool
    Enable proxy configuration. Default is false. When enabled is set to true, NSX validates connectivity to the proxy server. The test will fail if the proxy is unreachable.
    Host string
    Proxy server host (IP address or FQDN). Required when enabled is true.
    NsxId string
    NSX ID of the proxy configuration.
    Password string
    Password for proxy authentication. This field is sensitive. The password is write-only and not returned by the NSX API. It won't appear in state refresh operations.
    Port float64
    Proxy server port. Default is 3128. Valid range: 1-65535.
    ProxyConfigId string
    ID of the proxy configuration (always "TelemetryConfigIdentifier").
    Scheme string
    Proxy scheme. Valid values are HTTP and HTTPS. Default is HTTP. When using HTTPS scheme, you may need to provide a certificate_id. The certificate must be imported to NSX trust management first.
    TestConnectionUrl string
    URL to test proxy connectivity. Default is https://www.vmware.com.
    Username string
    Username for proxy authentication.
    certificate_id string
    Certificate ID for HTTPS proxy (from trust-management API). Required when scheme is HTTPS.
    description string
    Description (not supported by NSX for proxy config).
    enabled bool
    Enable proxy configuration. Default is false. When enabled is set to true, NSX validates connectivity to the proxy server. The test will fail if the proxy is unreachable.
    host string
    Proxy server host (IP address or FQDN). Required when enabled is true.
    nsx_id string
    NSX ID of the proxy configuration.
    password string
    Password for proxy authentication. This field is sensitive. The password is write-only and not returned by the NSX API. It won't appear in state refresh operations.
    port number
    Proxy server port. Default is 3128. Valid range: 1-65535.
    proxy_config_id string
    ID of the proxy configuration (always "TelemetryConfigIdentifier").
    scheme string
    Proxy scheme. Valid values are HTTP and HTTPS. Default is HTTP. When using HTTPS scheme, you may need to provide a certificate_id. The certificate must be imported to NSX trust management first.
    test_connection_url string
    URL to test proxy connectivity. Default is https://www.vmware.com.
    username string
    Username for proxy authentication.
    certificateId String
    Certificate ID for HTTPS proxy (from trust-management API). Required when scheme is HTTPS.
    description String
    Description (not supported by NSX for proxy config).
    enabled Boolean
    Enable proxy configuration. Default is false. When enabled is set to true, NSX validates connectivity to the proxy server. The test will fail if the proxy is unreachable.
    host String
    Proxy server host (IP address or FQDN). Required when enabled is true.
    nsxId String
    NSX ID of the proxy configuration.
    password String
    Password for proxy authentication. This field is sensitive. The password is write-only and not returned by the NSX API. It won't appear in state refresh operations.
    port Double
    Proxy server port. Default is 3128. Valid range: 1-65535.
    proxyConfigId String
    ID of the proxy configuration (always "TelemetryConfigIdentifier").
    scheme String
    Proxy scheme. Valid values are HTTP and HTTPS. Default is HTTP. When using HTTPS scheme, you may need to provide a certificate_id. The certificate must be imported to NSX trust management first.
    testConnectionUrl String
    URL to test proxy connectivity. Default is https://www.vmware.com.
    username String
    Username for proxy authentication.
    certificateId string
    Certificate ID for HTTPS proxy (from trust-management API). Required when scheme is HTTPS.
    description string
    Description (not supported by NSX for proxy config).
    enabled boolean
    Enable proxy configuration. Default is false. When enabled is set to true, NSX validates connectivity to the proxy server. The test will fail if the proxy is unreachable.
    host string
    Proxy server host (IP address or FQDN). Required when enabled is true.
    nsxId string
    NSX ID of the proxy configuration.
    password string
    Password for proxy authentication. This field is sensitive. The password is write-only and not returned by the NSX API. It won't appear in state refresh operations.
    port number
    Proxy server port. Default is 3128. Valid range: 1-65535.
    proxyConfigId string
    ID of the proxy configuration (always "TelemetryConfigIdentifier").
    scheme string
    Proxy scheme. Valid values are HTTP and HTTPS. Default is HTTP. When using HTTPS scheme, you may need to provide a certificate_id. The certificate must be imported to NSX trust management first.
    testConnectionUrl string
    URL to test proxy connectivity. Default is https://www.vmware.com.
    username string
    Username for proxy authentication.
    certificate_id str
    Certificate ID for HTTPS proxy (from trust-management API). Required when scheme is HTTPS.
    description str
    Description (not supported by NSX for proxy config).
    enabled bool
    Enable proxy configuration. Default is false. When enabled is set to true, NSX validates connectivity to the proxy server. The test will fail if the proxy is unreachable.
    host str
    Proxy server host (IP address or FQDN). Required when enabled is true.
    nsx_id str
    NSX ID of the proxy configuration.
    password str
    Password for proxy authentication. This field is sensitive. The password is write-only and not returned by the NSX API. It won't appear in state refresh operations.
    port float
    Proxy server port. Default is 3128. Valid range: 1-65535.
    proxy_config_id str
    ID of the proxy configuration (always "TelemetryConfigIdentifier").
    scheme str
    Proxy scheme. Valid values are HTTP and HTTPS. Default is HTTP. When using HTTPS scheme, you may need to provide a certificate_id. The certificate must be imported to NSX trust management first.
    test_connection_url str
    URL to test proxy connectivity. Default is https://www.vmware.com.
    username str
    Username for proxy authentication.
    certificateId String
    Certificate ID for HTTPS proxy (from trust-management API). Required when scheme is HTTPS.
    description String
    Description (not supported by NSX for proxy config).
    enabled Boolean
    Enable proxy configuration. Default is false. When enabled is set to true, NSX validates connectivity to the proxy server. The test will fail if the proxy is unreachable.
    host String
    Proxy server host (IP address or FQDN). Required when enabled is true.
    nsxId String
    NSX ID of the proxy configuration.
    password String
    Password for proxy authentication. This field is sensitive. The password is write-only and not returned by the NSX API. It won't appear in state refresh operations.
    port Number
    Proxy server port. Default is 3128. Valid range: 1-65535.
    proxyConfigId String
    ID of the proxy configuration (always "TelemetryConfigIdentifier").
    scheme String
    Proxy scheme. Valid values are HTTP and HTTPS. Default is HTTP. When using HTTPS scheme, you may need to provide a certificate_id. The certificate must be imported to NSX trust management first.
    testConnectionUrl String
    URL to test proxy connectivity. Default is https://www.vmware.com.
    username String
    Username for proxy authentication.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ProxyConfig resource produces the following output properties:

    DisplayName string
    Display name of the proxy configuration (managed by NSX).
    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the resource (/api/v1/proxy/config).
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server.
    DisplayName string
    Display name of the proxy configuration (managed by NSX).
    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the resource (/api/v1/proxy/config).
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server.
    display_name string
    Display name of the proxy configuration (managed by NSX).
    id string
    The provider-assigned unique ID for this managed resource.
    path string
    The NSX path of the resource (/api/v1/proxy/config).
    revision number
    Indicates current revision number of the object as seen by NSX-T API server.
    displayName String
    Display name of the proxy configuration (managed by NSX).
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the resource (/api/v1/proxy/config).
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server.
    displayName string
    Display name of the proxy configuration (managed by NSX).
    id string
    The provider-assigned unique ID for this managed resource.
    path string
    The NSX path of the resource (/api/v1/proxy/config).
    revision number
    Indicates current revision number of the object as seen by NSX-T API server.
    display_name str
    Display name of the proxy configuration (managed by NSX).
    id str
    The provider-assigned unique ID for this managed resource.
    path str
    The NSX path of the resource (/api/v1/proxy/config).
    revision float
    Indicates current revision number of the object as seen by NSX-T API server.
    displayName String
    Display name of the proxy configuration (managed by NSX).
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the resource (/api/v1/proxy/config).
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server.

    Look up Existing ProxyConfig Resource

    Get an existing ProxyConfig 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?: ProxyConfigState, opts?: CustomResourceOptions): ProxyConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        certificate_id: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        enabled: Optional[bool] = None,
        host: Optional[str] = None,
        nsx_id: Optional[str] = None,
        password: Optional[str] = None,
        path: Optional[str] = None,
        port: Optional[float] = None,
        proxy_config_id: Optional[str] = None,
        revision: Optional[float] = None,
        scheme: Optional[str] = None,
        test_connection_url: Optional[str] = None,
        username: Optional[str] = None) -> ProxyConfig
    func GetProxyConfig(ctx *Context, name string, id IDInput, state *ProxyConfigState, opts ...ResourceOption) (*ProxyConfig, error)
    public static ProxyConfig Get(string name, Input<string> id, ProxyConfigState? state, CustomResourceOptions? opts = null)
    public static ProxyConfig get(String name, Output<String> id, ProxyConfigState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:ProxyConfig    get:      id: ${id}
    import {
  to = nsxt_proxyconfig.example
  id = "${id}"
}
    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:
    CertificateId string
    Certificate ID for HTTPS proxy (from trust-management API). Required when scheme is HTTPS.
    Description string
    Description (not supported by NSX for proxy config).
    DisplayName string
    Display name of the proxy configuration (managed by NSX).
    Enabled bool
    Enable proxy configuration. Default is false. When enabled is set to true, NSX validates connectivity to the proxy server. The test will fail if the proxy is unreachable.
    Host string
    Proxy server host (IP address or FQDN). Required when enabled is true.
    NsxId string
    NSX ID of the proxy configuration.
    Password string
    Password for proxy authentication. This field is sensitive. The password is write-only and not returned by the NSX API. It won't appear in state refresh operations.
    Path string
    The NSX path of the resource (/api/v1/proxy/config).
    Port double
    Proxy server port. Default is 3128. Valid range: 1-65535.
    ProxyConfigId string
    ID of the proxy configuration (always "TelemetryConfigIdentifier").
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server.
    Scheme string
    Proxy scheme. Valid values are HTTP and HTTPS. Default is HTTP. When using HTTPS scheme, you may need to provide a certificate_id. The certificate must be imported to NSX trust management first.
    TestConnectionUrl string
    URL to test proxy connectivity. Default is https://www.vmware.com.
    Username string
    Username for proxy authentication.
    CertificateId string
    Certificate ID for HTTPS proxy (from trust-management API). Required when scheme is HTTPS.
    Description string
    Description (not supported by NSX for proxy config).
    DisplayName string
    Display name of the proxy configuration (managed by NSX).
    Enabled bool
    Enable proxy configuration. Default is false. When enabled is set to true, NSX validates connectivity to the proxy server. The test will fail if the proxy is unreachable.
    Host string
    Proxy server host (IP address or FQDN). Required when enabled is true.
    NsxId string
    NSX ID of the proxy configuration.
    Password string
    Password for proxy authentication. This field is sensitive. The password is write-only and not returned by the NSX API. It won't appear in state refresh operations.
    Path string
    The NSX path of the resource (/api/v1/proxy/config).
    Port float64
    Proxy server port. Default is 3128. Valid range: 1-65535.
    ProxyConfigId string
    ID of the proxy configuration (always "TelemetryConfigIdentifier").
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server.
    Scheme string
    Proxy scheme. Valid values are HTTP and HTTPS. Default is HTTP. When using HTTPS scheme, you may need to provide a certificate_id. The certificate must be imported to NSX trust management first.
    TestConnectionUrl string
    URL to test proxy connectivity. Default is https://www.vmware.com.
    Username string
    Username for proxy authentication.
    certificate_id string
    Certificate ID for HTTPS proxy (from trust-management API). Required when scheme is HTTPS.
    description string
    Description (not supported by NSX for proxy config).
    display_name string
    Display name of the proxy configuration (managed by NSX).
    enabled bool
    Enable proxy configuration. Default is false. When enabled is set to true, NSX validates connectivity to the proxy server. The test will fail if the proxy is unreachable.
    host string
    Proxy server host (IP address or FQDN). Required when enabled is true.
    nsx_id string
    NSX ID of the proxy configuration.
    password string
    Password for proxy authentication. This field is sensitive. The password is write-only and not returned by the NSX API. It won't appear in state refresh operations.
    path string
    The NSX path of the resource (/api/v1/proxy/config).
    port number
    Proxy server port. Default is 3128. Valid range: 1-65535.
    proxy_config_id string
    ID of the proxy configuration (always "TelemetryConfigIdentifier").
    revision number
    Indicates current revision number of the object as seen by NSX-T API server.
    scheme string
    Proxy scheme. Valid values are HTTP and HTTPS. Default is HTTP. When using HTTPS scheme, you may need to provide a certificate_id. The certificate must be imported to NSX trust management first.
    test_connection_url string
    URL to test proxy connectivity. Default is https://www.vmware.com.
    username string
    Username for proxy authentication.
    certificateId String
    Certificate ID for HTTPS proxy (from trust-management API). Required when scheme is HTTPS.
    description String
    Description (not supported by NSX for proxy config).
    displayName String
    Display name of the proxy configuration (managed by NSX).
    enabled Boolean
    Enable proxy configuration. Default is false. When enabled is set to true, NSX validates connectivity to the proxy server. The test will fail if the proxy is unreachable.
    host String
    Proxy server host (IP address or FQDN). Required when enabled is true.
    nsxId String
    NSX ID of the proxy configuration.
    password String
    Password for proxy authentication. This field is sensitive. The password is write-only and not returned by the NSX API. It won't appear in state refresh operations.
    path String
    The NSX path of the resource (/api/v1/proxy/config).
    port Double
    Proxy server port. Default is 3128. Valid range: 1-65535.
    proxyConfigId String
    ID of the proxy configuration (always "TelemetryConfigIdentifier").
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server.
    scheme String
    Proxy scheme. Valid values are HTTP and HTTPS. Default is HTTP. When using HTTPS scheme, you may need to provide a certificate_id. The certificate must be imported to NSX trust management first.
    testConnectionUrl String
    URL to test proxy connectivity. Default is https://www.vmware.com.
    username String
    Username for proxy authentication.
    certificateId string
    Certificate ID for HTTPS proxy (from trust-management API). Required when scheme is HTTPS.
    description string
    Description (not supported by NSX for proxy config).
    displayName string
    Display name of the proxy configuration (managed by NSX).
    enabled boolean
    Enable proxy configuration. Default is false. When enabled is set to true, NSX validates connectivity to the proxy server. The test will fail if the proxy is unreachable.
    host string
    Proxy server host (IP address or FQDN). Required when enabled is true.
    nsxId string
    NSX ID of the proxy configuration.
    password string
    Password for proxy authentication. This field is sensitive. The password is write-only and not returned by the NSX API. It won't appear in state refresh operations.
    path string
    The NSX path of the resource (/api/v1/proxy/config).
    port number
    Proxy server port. Default is 3128. Valid range: 1-65535.
    proxyConfigId string
    ID of the proxy configuration (always "TelemetryConfigIdentifier").
    revision number
    Indicates current revision number of the object as seen by NSX-T API server.
    scheme string
    Proxy scheme. Valid values are HTTP and HTTPS. Default is HTTP. When using HTTPS scheme, you may need to provide a certificate_id. The certificate must be imported to NSX trust management first.
    testConnectionUrl string
    URL to test proxy connectivity. Default is https://www.vmware.com.
    username string
    Username for proxy authentication.
    certificate_id str
    Certificate ID for HTTPS proxy (from trust-management API). Required when scheme is HTTPS.
    description str
    Description (not supported by NSX for proxy config).
    display_name str
    Display name of the proxy configuration (managed by NSX).
    enabled bool
    Enable proxy configuration. Default is false. When enabled is set to true, NSX validates connectivity to the proxy server. The test will fail if the proxy is unreachable.
    host str
    Proxy server host (IP address or FQDN). Required when enabled is true.
    nsx_id str
    NSX ID of the proxy configuration.
    password str
    Password for proxy authentication. This field is sensitive. The password is write-only and not returned by the NSX API. It won't appear in state refresh operations.
    path str
    The NSX path of the resource (/api/v1/proxy/config).
    port float
    Proxy server port. Default is 3128. Valid range: 1-65535.
    proxy_config_id str
    ID of the proxy configuration (always "TelemetryConfigIdentifier").
    revision float
    Indicates current revision number of the object as seen by NSX-T API server.
    scheme str
    Proxy scheme. Valid values are HTTP and HTTPS. Default is HTTP. When using HTTPS scheme, you may need to provide a certificate_id. The certificate must be imported to NSX trust management first.
    test_connection_url str
    URL to test proxy connectivity. Default is https://www.vmware.com.
    username str
    Username for proxy authentication.
    certificateId String
    Certificate ID for HTTPS proxy (from trust-management API). Required when scheme is HTTPS.
    description String
    Description (not supported by NSX for proxy config).
    displayName String
    Display name of the proxy configuration (managed by NSX).
    enabled Boolean
    Enable proxy configuration. Default is false. When enabled is set to true, NSX validates connectivity to the proxy server. The test will fail if the proxy is unreachable.
    host String
    Proxy server host (IP address or FQDN). Required when enabled is true.
    nsxId String
    NSX ID of the proxy configuration.
    password String
    Password for proxy authentication. This field is sensitive. The password is write-only and not returned by the NSX API. It won't appear in state refresh operations.
    path String
    The NSX path of the resource (/api/v1/proxy/config).
    port Number
    Proxy server port. Default is 3128. Valid range: 1-65535.
    proxyConfigId String
    ID of the proxy configuration (always "TelemetryConfigIdentifier").
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server.
    scheme String
    Proxy scheme. Valid values are HTTP and HTTPS. Default is HTTP. When using HTTPS scheme, you may need to provide a certificate_id. The certificate must be imported to NSX trust management first.
    testConnectionUrl String
    URL to test proxy connectivity. Default is https://www.vmware.com.
    username String
    Username for proxy authentication.

    Import

    ing

    An existing proxy configuration can be imported, for example:

    terraform import nsxt_proxy_config.internet_proxy TelemetryConfigIdentifier

    The above command imports the proxy configuration with the ID TelemetryConfigIdentifier (the singleton ID).

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

    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
    Schema (JSON)
    vmware/terraform-provider-nsxt

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial