vSphere

Pulumi Official
Package maintained by Pulumi
v4.1.0 published on Wednesday, Nov 24, 2021 by Pulumi

Provider

The provider type for the vsphere 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 a Provider Resource

new Provider(name: string, args: ProviderArgs, opts?: CustomResourceOptions);
@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             allow_unverified_ssl: Optional[bool] = None,
             api_timeout: Optional[int] = None,
             client_debug: Optional[bool] = None,
             client_debug_path: Optional[str] = None,
             client_debug_path_run: Optional[str] = None,
             password: Optional[str] = None,
             persist_session: Optional[bool] = None,
             rest_session_path: Optional[str] = None,
             user: Optional[str] = None,
             vcenter_server: Optional[str] = None,
             vim_keep_alive: Optional[int] = None,
             vim_session_path: Optional[str] = None,
             vsphere_server: Optional[str] = None)
@overload
def Provider(resource_name: str,
             args: ProviderArgs,
             opts: Optional[ResourceOptions] = None)
func NewProvider(ctx *Context, name string, args ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs args, CustomResourceOptions? opts = null)
public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)
type: pulumi:providers:vsphere
properties: # The arguments to resource properties.
options: # 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.
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

The Provider resource accepts the following input properties:

Password string

The user password for vSphere API operations.

User string

The user name for vSphere API operations.

AllowUnverifiedSsl bool

If set, VMware vSphere client will permit unverifiable SSL certificates. It can also be sourced from the following environment variable: VSPHERE_ALLOW_UNVERIFIED_SSL

ApiTimeout int

API timeout in minutes (Default: 5)

ClientDebug bool

govmomi debug It can also be sourced from the following environment variable: VSPHERE_CLIENT_DEBUG

ClientDebugPath string

govmomi debug path for debug It can also be sourced from the following environment variable: VSPHERE_CLIENT_DEBUG_PATH

ClientDebugPathRun string

govmomi debug path for a single run It can also be sourced from the following environment variable: VSPHERE_CLIENT_DEBUG_PATH_RUN

PersistSession bool

Persist vSphere client sessions to disk It can also be sourced from the following environment variable: VSPHERE_PERSIST_SESSION

RestSessionPath string

The directory to save vSphere REST API sessions to It can also be sourced from the following environment variable: VSPHERE_REST_SESSION_PATH

VcenterServer string

Deprecated:

This field has been renamed to vsphere_server.

VimKeepAlive int

Keep alive interval for the VIM session in minutes It can also be sourced from the following environment variable: VSPHERE_VIM_KEEP_ALIVE

VimSessionPath string

The directory to save vSphere SOAP API sessions to It can also be sourced from the following environment variable: VSPHERE_VIM_SESSION_PATH

VsphereServer string

The vSphere Server name for vSphere API operations.

Password string

The user password for vSphere API operations.

User string

The user name for vSphere API operations.

AllowUnverifiedSsl bool

If set, VMware vSphere client will permit unverifiable SSL certificates. It can also be sourced from the following environment variable: VSPHERE_ALLOW_UNVERIFIED_SSL

ApiTimeout int

API timeout in minutes (Default: 5)

ClientDebug bool

govmomi debug It can also be sourced from the following environment variable: VSPHERE_CLIENT_DEBUG

ClientDebugPath string

govmomi debug path for debug It can also be sourced from the following environment variable: VSPHERE_CLIENT_DEBUG_PATH

ClientDebugPathRun string

govmomi debug path for a single run It can also be sourced from the following environment variable: VSPHERE_CLIENT_DEBUG_PATH_RUN

PersistSession bool

Persist vSphere client sessions to disk It can also be sourced from the following environment variable: VSPHERE_PERSIST_SESSION

RestSessionPath string

The directory to save vSphere REST API sessions to It can also be sourced from the following environment variable: VSPHERE_REST_SESSION_PATH

VcenterServer string

Deprecated:

This field has been renamed to vsphere_server.

VimKeepAlive int

Keep alive interval for the VIM session in minutes It can also be sourced from the following environment variable: VSPHERE_VIM_KEEP_ALIVE

VimSessionPath string

The directory to save vSphere SOAP API sessions to It can also be sourced from the following environment variable: VSPHERE_VIM_SESSION_PATH

VsphereServer string

The vSphere Server name for vSphere API operations.

password String

The user password for vSphere API operations.

user String

The user name for vSphere API operations.

allowUnverifiedSsl Boolean

If set, VMware vSphere client will permit unverifiable SSL certificates. It can also be sourced from the following environment variable: VSPHERE_ALLOW_UNVERIFIED_SSL

apiTimeout Integer

API timeout in minutes (Default: 5)

clientDebug Boolean

govmomi debug It can also be sourced from the following environment variable: VSPHERE_CLIENT_DEBUG

clientDebugPath String

govmomi debug path for debug It can also be sourced from the following environment variable: VSPHERE_CLIENT_DEBUG_PATH

clientDebugPathRun String

govmomi debug path for a single run It can also be sourced from the following environment variable: VSPHERE_CLIENT_DEBUG_PATH_RUN

persistSession Boolean

Persist vSphere client sessions to disk It can also be sourced from the following environment variable: VSPHERE_PERSIST_SESSION

restSessionPath String

The directory to save vSphere REST API sessions to It can also be sourced from the following environment variable: VSPHERE_REST_SESSION_PATH

vcenterServer String

Deprecated:

This field has been renamed to vsphere_server.

vimKeepAlive Integer

Keep alive interval for the VIM session in minutes It can also be sourced from the following environment variable: VSPHERE_VIM_KEEP_ALIVE

vimSessionPath String

The directory to save vSphere SOAP API sessions to It can also be sourced from the following environment variable: VSPHERE_VIM_SESSION_PATH

vsphereServer String

The vSphere Server name for vSphere API operations.

password string

The user password for vSphere API operations.

user string

The user name for vSphere API operations.

allowUnverifiedSsl boolean

If set, VMware vSphere client will permit unverifiable SSL certificates. It can also be sourced from the following environment variable: VSPHERE_ALLOW_UNVERIFIED_SSL

apiTimeout number

API timeout in minutes (Default: 5)

clientDebug boolean

govmomi debug It can also be sourced from the following environment variable: VSPHERE_CLIENT_DEBUG

clientDebugPath string

govmomi debug path for debug It can also be sourced from the following environment variable: VSPHERE_CLIENT_DEBUG_PATH

clientDebugPathRun string

govmomi debug path for a single run It can also be sourced from the following environment variable: VSPHERE_CLIENT_DEBUG_PATH_RUN

persistSession boolean

Persist vSphere client sessions to disk It can also be sourced from the following environment variable: VSPHERE_PERSIST_SESSION

restSessionPath string

The directory to save vSphere REST API sessions to It can also be sourced from the following environment variable: VSPHERE_REST_SESSION_PATH

vcenterServer string

Deprecated:

This field has been renamed to vsphere_server.

vimKeepAlive number

Keep alive interval for the VIM session in minutes It can also be sourced from the following environment variable: VSPHERE_VIM_KEEP_ALIVE

vimSessionPath string

The directory to save vSphere SOAP API sessions to It can also be sourced from the following environment variable: VSPHERE_VIM_SESSION_PATH

vsphereServer string

The vSphere Server name for vSphere API operations.

password str

The user password for vSphere API operations.

user str

The user name for vSphere API operations.

allow_unverified_ssl bool

If set, VMware vSphere client will permit unverifiable SSL certificates. It can also be sourced from the following environment variable: VSPHERE_ALLOW_UNVERIFIED_SSL

api_timeout int

API timeout in minutes (Default: 5)

client_debug bool

govmomi debug It can also be sourced from the following environment variable: VSPHERE_CLIENT_DEBUG

client_debug_path str

govmomi debug path for debug It can also be sourced from the following environment variable: VSPHERE_CLIENT_DEBUG_PATH

client_debug_path_run str

govmomi debug path for a single run It can also be sourced from the following environment variable: VSPHERE_CLIENT_DEBUG_PATH_RUN

persist_session bool

Persist vSphere client sessions to disk It can also be sourced from the following environment variable: VSPHERE_PERSIST_SESSION

rest_session_path str

The directory to save vSphere REST API sessions to It can also be sourced from the following environment variable: VSPHERE_REST_SESSION_PATH

vcenter_server str

Deprecated:

This field has been renamed to vsphere_server.

vim_keep_alive int

Keep alive interval for the VIM session in minutes It can also be sourced from the following environment variable: VSPHERE_VIM_KEEP_ALIVE

vim_session_path str

The directory to save vSphere SOAP API sessions to It can also be sourced from the following environment variable: VSPHERE_VIM_SESSION_PATH

vsphere_server str

The vSphere Server name for vSphere API operations.

password String

The user password for vSphere API operations.

user String

The user name for vSphere API operations.

allowUnverifiedSsl Boolean

If set, VMware vSphere client will permit unverifiable SSL certificates. It can also be sourced from the following environment variable: VSPHERE_ALLOW_UNVERIFIED_SSL

apiTimeout Number

API timeout in minutes (Default: 5)

clientDebug Boolean

govmomi debug It can also be sourced from the following environment variable: VSPHERE_CLIENT_DEBUG

clientDebugPath String

govmomi debug path for debug It can also be sourced from the following environment variable: VSPHERE_CLIENT_DEBUG_PATH

clientDebugPathRun String

govmomi debug path for a single run It can also be sourced from the following environment variable: VSPHERE_CLIENT_DEBUG_PATH_RUN

persistSession Boolean

Persist vSphere client sessions to disk It can also be sourced from the following environment variable: VSPHERE_PERSIST_SESSION

restSessionPath String

The directory to save vSphere REST API sessions to It can also be sourced from the following environment variable: VSPHERE_REST_SESSION_PATH

vcenterServer String

Deprecated:

This field has been renamed to vsphere_server.

vimKeepAlive Number

Keep alive interval for the VIM session in minutes It can also be sourced from the following environment variable: VSPHERE_VIM_KEEP_ALIVE

vimSessionPath String

The directory to save vSphere SOAP API sessions to It can also be sourced from the following environment variable: VSPHERE_VIM_SESSION_PATH

vsphereServer String

The vSphere Server name for vSphere API operations.

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 str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Package Details

Repository
https://github.com/pulumi/pulumi-vsphere
License
Apache-2.0
Notes

This Pulumi package is based on the vsphere Terraform Provider.