Provider

Nutanix v0.14.0, May 21 26

Viewing docs for Nutanix v0.14.0
published on Thursday, May 21, 2026 by Piers Karsenbarg

Schema (JSON)

pierskarsenbarg/pulumi-nutanix

Viewing docs for Nutanix v0.14.0
published on Thursday, May 21, 2026 by Piers Karsenbarg

Schema (JSON)

pierskarsenbarg/pulumi-nutanix

The provider type for the nutanix package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Create Provider Resource

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

Constructor syntax

new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);

@overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             api_key: Optional[str] = None,
             custom_headers: Optional[Mapping[str, str]] = None,
             endpoint: Optional[str] = None,
             foundation_endpoint: Optional[str] = None,
             foundation_port: Optional[str] = None,
             insecure: Optional[bool] = None,
             ndb_endpoint: Optional[str] = None,
             ndb_password: Optional[str] = None,
             ndb_username: Optional[str] = None,
             password: Optional[str] = None,
             port: Optional[str] = None,
             proxy_url: Optional[str] = None,
             session_auth: Optional[bool] = None,
             username: Optional[str] = None,
             wait_timeout: Optional[int] = None)

func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)

public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)

public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

type: pulumi:providers:nutanix
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "pulumi_nutanix" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args ProviderArgs: 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 ProviderArgs: 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 ProviderArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

ApiKey string: API key for Nutanix Prism authentication. Can be used as an alternative to username/password. When set, the X-Ntnx-Api-Key header will be used instead of Basic Authentication.
CustomHeaders Dictionary<string, string>: Custom HTTP headers to add to all API requests. Useful for environments that require additional headers such as Cloudflare Access service tokens. Headers can also be set via environment variables with the NUTANIX_HEADER_ prefix (e.g., NUTANIX_HEADER_CF_ACCESS_CLIENT_ID becomes Cf-Access-Client-Id). Config values take precedence over env vars.
Endpoint string: URL for Nutanix Prism (e.g IP or FQDN for cluster VIP note, this is never the data services VIP, and should not be an individual CVM address, as this would cause calls to fail during cluster lifecycle management operations, such as AOS upgrades.
FoundationEndpoint string: endpoint for foundation VM (eg. Foundation VM IP)
FoundationPort string: Port for foundation VM
Insecure bool: Explicitly allow the provider to perform "insecure" SSL requests. If omitted,default value is false
NdbEndpoint string: endpoint for Era VM (era ip)
NdbPassword string
NdbUsername string
Password string: Password for provided user name.
Port string: Port for Nutanix Prism.
ProxyUrl string
SessionAuth bool: Use session authentification instead of basic auth for each request
Username string: User name for Nutanix Prism. Could be local cluster auth (e.g. 'admin') or directory auth.
WaitTimeout int: Set if you know that the creation o update of a resource may take long time (minutes)

ApiKey string: API key for Nutanix Prism authentication. Can be used as an alternative to username/password. When set, the X-Ntnx-Api-Key header will be used instead of Basic Authentication.
CustomHeaders map[string]string: Custom HTTP headers to add to all API requests. Useful for environments that require additional headers such as Cloudflare Access service tokens. Headers can also be set via environment variables with the NUTANIX_HEADER_ prefix (e.g., NUTANIX_HEADER_CF_ACCESS_CLIENT_ID becomes Cf-Access-Client-Id). Config values take precedence over env vars.
Endpoint string: URL for Nutanix Prism (e.g IP or FQDN for cluster VIP note, this is never the data services VIP, and should not be an individual CVM address, as this would cause calls to fail during cluster lifecycle management operations, such as AOS upgrades.
FoundationEndpoint string: endpoint for foundation VM (eg. Foundation VM IP)
FoundationPort string: Port for foundation VM
Insecure bool: Explicitly allow the provider to perform "insecure" SSL requests. If omitted,default value is false
NdbEndpoint string: endpoint for Era VM (era ip)
NdbPassword string
NdbUsername string
Password string: Password for provided user name.
Port string: Port for Nutanix Prism.
ProxyUrl string
SessionAuth bool: Use session authentification instead of basic auth for each request
Username string: User name for Nutanix Prism. Could be local cluster auth (e.g. 'admin') or directory auth.
WaitTimeout int: Set if you know that the creation o update of a resource may take long time (minutes)

api_key string: API key for Nutanix Prism authentication. Can be used as an alternative to username/password. When set, the X-Ntnx-Api-Key header will be used instead of Basic Authentication.
custom_headers map(string): Custom HTTP headers to add to all API requests. Useful for environments that require additional headers such as Cloudflare Access service tokens. Headers can also be set via environment variables with the NUTANIX_HEADER_ prefix (e.g., NUTANIX_HEADER_CF_ACCESS_CLIENT_ID becomes Cf-Access-Client-Id). Config values take precedence over env vars.
endpoint string: URL for Nutanix Prism (e.g IP or FQDN for cluster VIP note, this is never the data services VIP, and should not be an individual CVM address, as this would cause calls to fail during cluster lifecycle management operations, such as AOS upgrades.
foundation_endpoint string: endpoint for foundation VM (eg. Foundation VM IP)
foundation_port string: Port for foundation VM
insecure bool: Explicitly allow the provider to perform "insecure" SSL requests. If omitted,default value is false
ndb_endpoint string: endpoint for Era VM (era ip)
ndb_password string
ndb_username string
password string: Password for provided user name.
port string: Port for Nutanix Prism.
proxy_url string
session_auth bool: Use session authentification instead of basic auth for each request
username string: User name for Nutanix Prism. Could be local cluster auth (e.g. 'admin') or directory auth.
wait_timeout number: Set if you know that the creation o update of a resource may take long time (minutes)

apiKey String: API key for Nutanix Prism authentication. Can be used as an alternative to username/password. When set, the X-Ntnx-Api-Key header will be used instead of Basic Authentication.
customHeaders Map<String,String>: Custom HTTP headers to add to all API requests. Useful for environments that require additional headers such as Cloudflare Access service tokens. Headers can also be set via environment variables with the NUTANIX_HEADER_ prefix (e.g., NUTANIX_HEADER_CF_ACCESS_CLIENT_ID becomes Cf-Access-Client-Id). Config values take precedence over env vars.
endpoint String: URL for Nutanix Prism (e.g IP or FQDN for cluster VIP note, this is never the data services VIP, and should not be an individual CVM address, as this would cause calls to fail during cluster lifecycle management operations, such as AOS upgrades.
foundationEndpoint String: endpoint for foundation VM (eg. Foundation VM IP)
foundationPort String: Port for foundation VM
insecure Boolean: Explicitly allow the provider to perform "insecure" SSL requests. If omitted,default value is false
ndbEndpoint String: endpoint for Era VM (era ip)
ndbPassword String
ndbUsername String
password String: Password for provided user name.
port String: Port for Nutanix Prism.
proxyUrl String
sessionAuth Boolean: Use session authentification instead of basic auth for each request
username String: User name for Nutanix Prism. Could be local cluster auth (e.g. 'admin') or directory auth.
waitTimeout Integer: Set if you know that the creation o update of a resource may take long time (minutes)

apiKey string: API key for Nutanix Prism authentication. Can be used as an alternative to username/password. When set, the X-Ntnx-Api-Key header will be used instead of Basic Authentication.
customHeaders {[key: string]: string}: Custom HTTP headers to add to all API requests. Useful for environments that require additional headers such as Cloudflare Access service tokens. Headers can also be set via environment variables with the NUTANIX_HEADER_ prefix (e.g., NUTANIX_HEADER_CF_ACCESS_CLIENT_ID becomes Cf-Access-Client-Id). Config values take precedence over env vars.
endpoint string: URL for Nutanix Prism (e.g IP or FQDN for cluster VIP note, this is never the data services VIP, and should not be an individual CVM address, as this would cause calls to fail during cluster lifecycle management operations, such as AOS upgrades.
foundationEndpoint string: endpoint for foundation VM (eg. Foundation VM IP)
foundationPort string: Port for foundation VM
insecure boolean: Explicitly allow the provider to perform "insecure" SSL requests. If omitted,default value is false
ndbEndpoint string: endpoint for Era VM (era ip)
ndbPassword string
ndbUsername string
password string: Password for provided user name.
port string: Port for Nutanix Prism.
proxyUrl string
sessionAuth boolean: Use session authentification instead of basic auth for each request
username string: User name for Nutanix Prism. Could be local cluster auth (e.g. 'admin') or directory auth.
waitTimeout number: Set if you know that the creation o update of a resource may take long time (minutes)

api_key str: API key for Nutanix Prism authentication. Can be used as an alternative to username/password. When set, the X-Ntnx-Api-Key header will be used instead of Basic Authentication.
custom_headers Mapping[str, str]: Custom HTTP headers to add to all API requests. Useful for environments that require additional headers such as Cloudflare Access service tokens. Headers can also be set via environment variables with the NUTANIX_HEADER_ prefix (e.g., NUTANIX_HEADER_CF_ACCESS_CLIENT_ID becomes Cf-Access-Client-Id). Config values take precedence over env vars.
endpoint str: URL for Nutanix Prism (e.g IP or FQDN for cluster VIP note, this is never the data services VIP, and should not be an individual CVM address, as this would cause calls to fail during cluster lifecycle management operations, such as AOS upgrades.
foundation_endpoint str: endpoint for foundation VM (eg. Foundation VM IP)
foundation_port str: Port for foundation VM
insecure bool: Explicitly allow the provider to perform "insecure" SSL requests. If omitted,default value is false
ndb_endpoint str: endpoint for Era VM (era ip)
ndb_password str
ndb_username str
password str: Password for provided user name.
port str: Port for Nutanix Prism.
proxy_url str
session_auth bool: Use session authentification instead of basic auth for each request
username str: User name for Nutanix Prism. Could be local cluster auth (e.g. 'admin') or directory auth.
wait_timeout int: Set if you know that the creation o update of a resource may take long time (minutes)

apiKey String: API key for Nutanix Prism authentication. Can be used as an alternative to username/password. When set, the X-Ntnx-Api-Key header will be used instead of Basic Authentication.
customHeaders Map<String>: Custom HTTP headers to add to all API requests. Useful for environments that require additional headers such as Cloudflare Access service tokens. Headers can also be set via environment variables with the NUTANIX_HEADER_ prefix (e.g., NUTANIX_HEADER_CF_ACCESS_CLIENT_ID becomes Cf-Access-Client-Id). Config values take precedence over env vars.
endpoint String: URL for Nutanix Prism (e.g IP or FQDN for cluster VIP note, this is never the data services VIP, and should not be an individual CVM address, as this would cause calls to fail during cluster lifecycle management operations, such as AOS upgrades.
foundationEndpoint String: endpoint for foundation VM (eg. Foundation VM IP)
foundationPort String: Port for foundation VM
insecure Boolean: Explicitly allow the provider to perform "insecure" SSL requests. If omitted,default value is false
ndbEndpoint String: endpoint for Era VM (era ip)
ndbPassword String
ndbUsername String
password String: Password for provided user name.
port String: Port for Nutanix Prism.
proxyUrl String
sessionAuth Boolean: Use session authentification instead of basic auth for each request
username String: User name for Nutanix Prism. Could be local cluster auth (e.g. 'admin') or directory auth.
waitTimeout Number: Set if you know that the creation o update of a resource may take long time (minutes)

Outputs

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

Provider Resource Methods

TerraformConfig Method

This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.

Using TerraformConfig

terraformConfig(): Output<Provider.TerraformConfigResult>

def terraform_config() -> Output[Provider.Terraform_configResult]

func (r *Provider) TerraformConfig() (ProviderTerraformConfigResultOutput, error)

public Output<Provider.TerraformConfigResult> TerraformConfig()

TerraformConfig Result

Result Dictionary<string, object>

Result map[string]interface{}

result map(any)

result Map<String,Object>

result {[key: string]: any}

result Mapping[str, Any]

result Map<Any>

Package Details

Repository: nutanix pierskarsenbarg/pulumi-nutanix
License: Apache-2.0
Notes: This Pulumi package is based on the nutanix Terraform Provider.

Viewing docs for Nutanix v0.14.0
published on Thursday, May 21, 2026 by Piers Karsenbarg

Schema (JSON)

pierskarsenbarg/pulumi-nutanix

nutanix.Provider

On this page

On this page

Create Provider Resource

Constructor syntax

Parameters

Provider Resource Properties

Inputs

Outputs

Provider Resource Methods

TerraformConfig Method

Using TerraformConfig

TerraformConfig Result

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

nutanix.Provider

On this page

On this page

Create Provider Resource

Constructor syntax

Parameters

Provider Resource Properties

Inputs

Outputs

Provider Resource Methods

TerraformConfig Method

Using TerraformConfig

TerraformConfig Result

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.