Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. Provider
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.Provider

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

    The provider type for the vcd 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: ProviderArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             allow_api_token_file: Optional[bool] = None,
             allow_service_account_token_file: Optional[bool] = None,
             allow_unverified_ssl: Optional[bool] = None,
             api_token: Optional[str] = None,
             api_token_file: Optional[str] = None,
             auth_type: Optional[str] = None,
             ignore_metadata_changes: Optional[Sequence[ProviderIgnoreMetadataChangeArgs]] = None,
             import_separator: Optional[str] = None,
             logging: Optional[bool] = None,
             logging_file: Optional[str] = None,
             max_retry_timeout: Optional[float] = None,
             org: Optional[str] = None,
             password: Optional[str] = None,
             saml_adfs_cookie: Optional[str] = None,
             saml_adfs_rpt_id: Optional[str] = None,
             service_account_token_file: Optional[str] = None,
             sysorg: Optional[str] = None,
             token: Optional[str] = None,
             url: Optional[str] = None,
             user: Optional[str] = None,
             vdc: Optional[str] = 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:vcd
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    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:

    Org string
    The VCD Org for API operations
    Url string
    The VCD url for VCD API operations.
    AllowApiTokenFile bool
    Set this to true if you understand the security risks of using API token files and would like to suppress the warnings
    AllowServiceAccountTokenFile bool
    Set this to true if you understand the security risks of using Service Account token files and would like to suppress the warnings
    AllowUnverifiedSsl bool
    If set, VCDClient will permit unverifiable SSL certificates.
    ApiToken string
    The API token used instead of username/password for VCD API operations. (Requires VCD 10.3.1+)
    ApiTokenFile string
    The API token file instead of username/password for VCD API operations. (Requires VCD 10.3.1+)
    AuthType string
    'integrated', 'saml_adfs', 'token', 'api_token', 'api_token_file' and 'service_account_token_file' are supported. 'integrated' is default.
    IgnoreMetadataChanges List<ProviderIgnoreMetadataChange>
    Defines a set of metadata_entry that need to be ignored by this provider. All filters on this attribute are computed with a logical AND
    ImportSeparator string
    Logging bool
    If set, it will enable logging of API requests and responses
    LoggingFile string
    Defines the full name of the logging file for API calls (requires 'logging')
    MaxRetryTimeout double
    Max num seconds to wait for successful response when operating on resources within vCloud (defaults to 60)
    Password string
    The user password for VCD API operations.
    SamlAdfsCookie string
    Allows to specify custom cookie for ADFS server lookup. '{{.Org}}' is replaced by real Org - e.g. 'sso-preferred=yes; sso_redirect_org={{.Org}}'
    SamlAdfsRptId string
    Allows to specify custom Relaying Party Trust Identifier for auth_type=saml_adfs
    ServiceAccountTokenFile string
    The Service Account API token file instead of username/password for VCD API operations. (Requires VCD 10.4.0+)
    Sysorg string
    The VCD Org for user authentication
    Token string
    The token used instead of username/password for VCD API operations.
    User string
    The user name for VCD API operations.
    Vdc string
    The VDC for API operations
    Org string
    The VCD Org for API operations
    Url string
    The VCD url for VCD API operations.
    AllowApiTokenFile bool
    Set this to true if you understand the security risks of using API token files and would like to suppress the warnings
    AllowServiceAccountTokenFile bool
    Set this to true if you understand the security risks of using Service Account token files and would like to suppress the warnings
    AllowUnverifiedSsl bool
    If set, VCDClient will permit unverifiable SSL certificates.
    ApiToken string
    The API token used instead of username/password for VCD API operations. (Requires VCD 10.3.1+)
    ApiTokenFile string
    The API token file instead of username/password for VCD API operations. (Requires VCD 10.3.1+)
    AuthType string
    'integrated', 'saml_adfs', 'token', 'api_token', 'api_token_file' and 'service_account_token_file' are supported. 'integrated' is default.
    IgnoreMetadataChanges []ProviderIgnoreMetadataChangeArgs
    Defines a set of metadata_entry that need to be ignored by this provider. All filters on this attribute are computed with a logical AND
    ImportSeparator string
    Logging bool
    If set, it will enable logging of API requests and responses
    LoggingFile string
    Defines the full name of the logging file for API calls (requires 'logging')
    MaxRetryTimeout float64
    Max num seconds to wait for successful response when operating on resources within vCloud (defaults to 60)
    Password string
    The user password for VCD API operations.
    SamlAdfsCookie string
    Allows to specify custom cookie for ADFS server lookup. '{{.Org}}' is replaced by real Org - e.g. 'sso-preferred=yes; sso_redirect_org={{.Org}}'
    SamlAdfsRptId string
    Allows to specify custom Relaying Party Trust Identifier for auth_type=saml_adfs
    ServiceAccountTokenFile string
    The Service Account API token file instead of username/password for VCD API operations. (Requires VCD 10.4.0+)
    Sysorg string
    The VCD Org for user authentication
    Token string
    The token used instead of username/password for VCD API operations.
    User string
    The user name for VCD API operations.
    Vdc string
    The VDC for API operations
    org String
    The VCD Org for API operations
    url String
    The VCD url for VCD API operations.
    allowApiTokenFile Boolean
    Set this to true if you understand the security risks of using API token files and would like to suppress the warnings
    allowServiceAccountTokenFile Boolean
    Set this to true if you understand the security risks of using Service Account token files and would like to suppress the warnings
    allowUnverifiedSsl Boolean
    If set, VCDClient will permit unverifiable SSL certificates.
    apiToken String
    The API token used instead of username/password for VCD API operations. (Requires VCD 10.3.1+)
    apiTokenFile String
    The API token file instead of username/password for VCD API operations. (Requires VCD 10.3.1+)
    authType String
    'integrated', 'saml_adfs', 'token', 'api_token', 'api_token_file' and 'service_account_token_file' are supported. 'integrated' is default.
    ignoreMetadataChanges List<ProviderIgnoreMetadataChange>
    Defines a set of metadata_entry that need to be ignored by this provider. All filters on this attribute are computed with a logical AND
    importSeparator String
    logging Boolean
    If set, it will enable logging of API requests and responses
    loggingFile String
    Defines the full name of the logging file for API calls (requires 'logging')
    maxRetryTimeout Double
    Max num seconds to wait for successful response when operating on resources within vCloud (defaults to 60)
    password String
    The user password for VCD API operations.
    samlAdfsCookie String
    Allows to specify custom cookie for ADFS server lookup. '{{.Org}}' is replaced by real Org - e.g. 'sso-preferred=yes; sso_redirect_org={{.Org}}'
    samlAdfsRptId String
    Allows to specify custom Relaying Party Trust Identifier for auth_type=saml_adfs
    serviceAccountTokenFile String
    The Service Account API token file instead of username/password for VCD API operations. (Requires VCD 10.4.0+)
    sysorg String
    The VCD Org for user authentication
    token String
    The token used instead of username/password for VCD API operations.
    user String
    The user name for VCD API operations.
    vdc String
    The VDC for API operations
    org string
    The VCD Org for API operations
    url string
    The VCD url for VCD API operations.
    allowApiTokenFile boolean
    Set this to true if you understand the security risks of using API token files and would like to suppress the warnings
    allowServiceAccountTokenFile boolean
    Set this to true if you understand the security risks of using Service Account token files and would like to suppress the warnings
    allowUnverifiedSsl boolean
    If set, VCDClient will permit unverifiable SSL certificates.
    apiToken string
    The API token used instead of username/password for VCD API operations. (Requires VCD 10.3.1+)
    apiTokenFile string
    The API token file instead of username/password for VCD API operations. (Requires VCD 10.3.1+)
    authType string
    'integrated', 'saml_adfs', 'token', 'api_token', 'api_token_file' and 'service_account_token_file' are supported. 'integrated' is default.
    ignoreMetadataChanges ProviderIgnoreMetadataChange[]
    Defines a set of metadata_entry that need to be ignored by this provider. All filters on this attribute are computed with a logical AND
    importSeparator string
    logging boolean
    If set, it will enable logging of API requests and responses
    loggingFile string
    Defines the full name of the logging file for API calls (requires 'logging')
    maxRetryTimeout number
    Max num seconds to wait for successful response when operating on resources within vCloud (defaults to 60)
    password string
    The user password for VCD API operations.
    samlAdfsCookie string
    Allows to specify custom cookie for ADFS server lookup. '{{.Org}}' is replaced by real Org - e.g. 'sso-preferred=yes; sso_redirect_org={{.Org}}'
    samlAdfsRptId string
    Allows to specify custom Relaying Party Trust Identifier for auth_type=saml_adfs
    serviceAccountTokenFile string
    The Service Account API token file instead of username/password for VCD API operations. (Requires VCD 10.4.0+)
    sysorg string
    The VCD Org for user authentication
    token string
    The token used instead of username/password for VCD API operations.
    user string
    The user name for VCD API operations.
    vdc string
    The VDC for API operations
    org str
    The VCD Org for API operations
    url str
    The VCD url for VCD API operations.
    allow_api_token_file bool
    Set this to true if you understand the security risks of using API token files and would like to suppress the warnings
    allow_service_account_token_file bool
    Set this to true if you understand the security risks of using Service Account token files and would like to suppress the warnings
    allow_unverified_ssl bool
    If set, VCDClient will permit unverifiable SSL certificates.
    api_token str
    The API token used instead of username/password for VCD API operations. (Requires VCD 10.3.1+)
    api_token_file str
    The API token file instead of username/password for VCD API operations. (Requires VCD 10.3.1+)
    auth_type str
    'integrated', 'saml_adfs', 'token', 'api_token', 'api_token_file' and 'service_account_token_file' are supported. 'integrated' is default.
    ignore_metadata_changes Sequence[ProviderIgnoreMetadataChangeArgs]
    Defines a set of metadata_entry that need to be ignored by this provider. All filters on this attribute are computed with a logical AND
    import_separator str
    logging bool
    If set, it will enable logging of API requests and responses
    logging_file str
    Defines the full name of the logging file for API calls (requires 'logging')
    max_retry_timeout float
    Max num seconds to wait for successful response when operating on resources within vCloud (defaults to 60)
    password str
    The user password for VCD API operations.
    saml_adfs_cookie str
    Allows to specify custom cookie for ADFS server lookup. '{{.Org}}' is replaced by real Org - e.g. 'sso-preferred=yes; sso_redirect_org={{.Org}}'
    saml_adfs_rpt_id str
    Allows to specify custom Relaying Party Trust Identifier for auth_type=saml_adfs
    service_account_token_file str
    The Service Account API token file instead of username/password for VCD API operations. (Requires VCD 10.4.0+)
    sysorg str
    The VCD Org for user authentication
    token str
    The token used instead of username/password for VCD API operations.
    user str
    The user name for VCD API operations.
    vdc str
    The VDC for API operations
    org String
    The VCD Org for API operations
    url String
    The VCD url for VCD API operations.
    allowApiTokenFile Boolean
    Set this to true if you understand the security risks of using API token files and would like to suppress the warnings
    allowServiceAccountTokenFile Boolean
    Set this to true if you understand the security risks of using Service Account token files and would like to suppress the warnings
    allowUnverifiedSsl Boolean
    If set, VCDClient will permit unverifiable SSL certificates.
    apiToken String
    The API token used instead of username/password for VCD API operations. (Requires VCD 10.3.1+)
    apiTokenFile String
    The API token file instead of username/password for VCD API operations. (Requires VCD 10.3.1+)
    authType String
    'integrated', 'saml_adfs', 'token', 'api_token', 'api_token_file' and 'service_account_token_file' are supported. 'integrated' is default.
    ignoreMetadataChanges List<Property Map>
    Defines a set of metadata_entry that need to be ignored by this provider. All filters on this attribute are computed with a logical AND
    importSeparator String
    logging Boolean
    If set, it will enable logging of API requests and responses
    loggingFile String
    Defines the full name of the logging file for API calls (requires 'logging')
    maxRetryTimeout Number
    Max num seconds to wait for successful response when operating on resources within vCloud (defaults to 60)
    password String
    The user password for VCD API operations.
    samlAdfsCookie String
    Allows to specify custom cookie for ADFS server lookup. '{{.Org}}' is replaced by real Org - e.g. 'sso-preferred=yes; sso_redirect_org={{.Org}}'
    samlAdfsRptId String
    Allows to specify custom Relaying Party Trust Identifier for auth_type=saml_adfs
    serviceAccountTokenFile String
    The Service Account API token file instead of username/password for VCD API operations. (Requires VCD 10.4.0+)
    sysorg String
    The VCD Org for user authentication
    token String
    The token used instead of username/password for VCD API operations.
    user String
    The user name for VCD API operations.
    vdc String
    The VDC for 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.

    Supporting Types

    ProviderIgnoreMetadataChange, ProviderIgnoreMetadataChangeArgs

    ConflictAction string
    KeyRegex string
    Regular expression of the metadata entry keys to ignore. Either key_regex or value_regex is required
    ResourceName string
    Ignores metadata from the specific entity in VCD named like this argument
    ResourceType string
    Ignores metadata from the specific resource type
    ValueRegex string
    Regular expression of the metadata entry values to ignore. Either key_regex or value_regex is required
    ConflictAction string
    KeyRegex string
    Regular expression of the metadata entry keys to ignore. Either key_regex or value_regex is required
    ResourceName string
    Ignores metadata from the specific entity in VCD named like this argument
    ResourceType string
    Ignores metadata from the specific resource type
    ValueRegex string
    Regular expression of the metadata entry values to ignore. Either key_regex or value_regex is required
    conflictAction String
    keyRegex String
    Regular expression of the metadata entry keys to ignore. Either key_regex or value_regex is required
    resourceName String
    Ignores metadata from the specific entity in VCD named like this argument
    resourceType String
    Ignores metadata from the specific resource type
    valueRegex String
    Regular expression of the metadata entry values to ignore. Either key_regex or value_regex is required
    conflictAction string
    keyRegex string
    Regular expression of the metadata entry keys to ignore. Either key_regex or value_regex is required
    resourceName string
    Ignores metadata from the specific entity in VCD named like this argument
    resourceType string
    Ignores metadata from the specific resource type
    valueRegex string
    Regular expression of the metadata entry values to ignore. Either key_regex or value_regex is required
    conflict_action str
    key_regex str
    Regular expression of the metadata entry keys to ignore. Either key_regex or value_regex is required
    resource_name str
    Ignores metadata from the specific entity in VCD named like this argument
    resource_type str
    Ignores metadata from the specific resource type
    value_regex str
    Regular expression of the metadata entry values to ignore. Either key_regex or value_regex is required
    conflictAction String
    keyRegex String
    Regular expression of the metadata entry keys to ignore. Either key_regex or value_regex is required
    resourceName String
    Ignores metadata from the specific entity in VCD named like this argument
    resourceType String
    Ignores metadata from the specific resource type
    valueRegex String
    Regular expression of the metadata entry values to ignore. Either key_regex or value_regex is required

    Package Details

    Repository
    vcd vmware/terraform-provider-vcd
    License
    Notes
    This Pulumi package is based on the vcd Terraform Provider.
    vcd logo
    vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
    vmware/terraform-provider-vcd