Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nutanix
  3. API Docs
  4. NdbDbserverVm
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

nutanix.NdbDbserverVm

Explore with Pulumi AI

nutanix logo
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

    Provides a resource to create database server VMs based on the input parameters. For 1.8.0 release, only postgress database type is qualified and officially supported.

    Example Usage

    Create NdbDbserverVm Resource

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

    Constructor syntax

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

@overload
def NdbDbserverVm(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  compute_profile_id: Optional[str] = None,
                  nx_cluster_id: Optional[str] = None,
                  database_type: Optional[str] = None,
                  network_profile_id: Optional[str] = None,
                  delete_vm_snapshots: Optional[bool] = None,
                  snapshot_id: Optional[str] = None,
                  description: Optional[str] = None,
                  latest_snapshot: Optional[bool] = None,
                  maintenance_tasks: Optional[NdbDbserverVmMaintenanceTasksArgs] = None,
                  delete: Optional[bool] = None,
                  credentials: Optional[Sequence[NdbDbserverVmCredentialArgs]] = None,
                  postgres_databases: Optional[Sequence[NdbDbserverVmPostgresDatabaseArgs]] = None,
                  remove: Optional[bool] = None,
                  delete_vgs: Optional[bool] = None,
                  soft_remove: Optional[bool] = None,
                  software_profile_id: Optional[str] = None,
                  software_profile_version_id: Optional[str] = None,
                  tags: Optional[Sequence[NdbDbserverVmTagArgs]] = None,
                  time_machine_id: Optional[str] = None,
                  timezone: Optional[str] = None,
                  vm_password: Optional[str] = None)
    func NewNdbDbserverVm(ctx *Context, name string, args NdbDbserverVmArgs, opts ...ResourceOption) (*NdbDbserverVm, error)
    public NdbDbserverVm(string name, NdbDbserverVmArgs args, CustomResourceOptions? opts = null)
    public NdbDbserverVm(String name, NdbDbserverVmArgs args)
public NdbDbserverVm(String name, NdbDbserverVmArgs args, CustomResourceOptions options)

    type: nutanix:NdbDbserverVm
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 NdbDbserverVmArgs
    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 NdbDbserverVmArgs
    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 NdbDbserverVmArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NdbDbserverVmArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NdbDbserverVmArgs
    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 ndbDbserverVmResource = new Nutanix.NdbDbserverVm("ndbDbserverVmResource", new()
{
    ComputeProfileId = "string",
    NxClusterId = "string",
    DatabaseType = "string",
    NetworkProfileId = "string",
    DeleteVmSnapshots = false,
    SnapshotId = "string",
    Description = "string",
    LatestSnapshot = false,
    MaintenanceTasks = new Nutanix.Inputs.NdbDbserverVmMaintenanceTasksArgs
    {
        MaintenanceWindowId = "string",
        Tasks = new[]
        {
            new Nutanix.Inputs.NdbDbserverVmMaintenanceTasksTaskArgs
            {
                PostCommand = "string",
                PreCommand = "string",
                TaskType = "string",
            },
        },
    },
    Delete = false,
    Credentials = new[]
    {
        new Nutanix.Inputs.NdbDbserverVmCredentialArgs
        {
            Password = "string",
            Username = "string",
            Label = "string",
        },
    },
    PostgresDatabases = new[]
    {
        new Nutanix.Inputs.NdbDbserverVmPostgresDatabaseArgs
        {
            VmName = "string",
            ClientPublicKey = "string",
        },
    },
    Remove = false,
    DeleteVgs = false,
    SoftRemove = false,
    SoftwareProfileId = "string",
    SoftwareProfileVersionId = "string",
    Tags = new[]
    {
        new Nutanix.Inputs.NdbDbserverVmTagArgs
        {
            EntityId = "string",
            EntityType = "string",
            TagId = "string",
            TagName = "string",
            Value = "string",
        },
    },
    TimeMachineId = "string",
    Timezone = "string",
    VmPassword = "string",
});

    example, err := nutanix.NewNdbDbserverVm(ctx, "ndbDbserverVmResource", &nutanix.NdbDbserverVmArgs{
	ComputeProfileId:  pulumi.String("string"),
	NxClusterId:       pulumi.String("string"),
	DatabaseType:      pulumi.String("string"),
	NetworkProfileId:  pulumi.String("string"),
	DeleteVmSnapshots: pulumi.Bool(false),
	SnapshotId:        pulumi.String("string"),
	Description:       pulumi.String("string"),
	LatestSnapshot:    pulumi.Bool(false),
	MaintenanceTasks: &nutanix.NdbDbserverVmMaintenanceTasksArgs{
		MaintenanceWindowId: pulumi.String("string"),
		Tasks: nutanix.NdbDbserverVmMaintenanceTasksTaskArray{
			&nutanix.NdbDbserverVmMaintenanceTasksTaskArgs{
				PostCommand: pulumi.String("string"),
				PreCommand:  pulumi.String("string"),
				TaskType:    pulumi.String("string"),
			},
		},
	},
	Delete: pulumi.Bool(false),
	Credentials: nutanix.NdbDbserverVmCredentialArray{
		&nutanix.NdbDbserverVmCredentialArgs{
			Password: pulumi.String("string"),
			Username: pulumi.String("string"),
			Label:    pulumi.String("string"),
		},
	},
	PostgresDatabases: nutanix.NdbDbserverVmPostgresDatabaseArray{
		&nutanix.NdbDbserverVmPostgresDatabaseArgs{
			VmName:          pulumi.String("string"),
			ClientPublicKey: pulumi.String("string"),
		},
	},
	Remove:                   pulumi.Bool(false),
	DeleteVgs:                pulumi.Bool(false),
	SoftRemove:               pulumi.Bool(false),
	SoftwareProfileId:        pulumi.String("string"),
	SoftwareProfileVersionId: pulumi.String("string"),
	Tags: nutanix.NdbDbserverVmTagArray{
		&nutanix.NdbDbserverVmTagArgs{
			EntityId:   pulumi.String("string"),
			EntityType: pulumi.String("string"),
			TagId:      pulumi.String("string"),
			TagName:    pulumi.String("string"),
			Value:      pulumi.String("string"),
		},
	},
	TimeMachineId: pulumi.String("string"),
	Timezone:      pulumi.String("string"),
	VmPassword:    pulumi.String("string"),
})

    var ndbDbserverVmResource = new NdbDbserverVm("ndbDbserverVmResource", NdbDbserverVmArgs.builder()
    .computeProfileId("string")
    .nxClusterId("string")
    .databaseType("string")
    .networkProfileId("string")
    .deleteVmSnapshots(false)
    .snapshotId("string")
    .description("string")
    .latestSnapshot(false)
    .maintenanceTasks(NdbDbserverVmMaintenanceTasksArgs.builder()
        .maintenanceWindowId("string")
        .tasks(NdbDbserverVmMaintenanceTasksTaskArgs.builder()
            .postCommand("string")
            .preCommand("string")
            .taskType("string")
            .build())
        .build())
    .delete(false)
    .credentials(NdbDbserverVmCredentialArgs.builder()
        .password("string")
        .username("string")
        .label("string")
        .build())
    .postgresDatabases(NdbDbserverVmPostgresDatabaseArgs.builder()
        .vmName("string")
        .clientPublicKey("string")
        .build())
    .remove(false)
    .deleteVgs(false)
    .softRemove(false)
    .softwareProfileId("string")
    .softwareProfileVersionId("string")
    .tags(NdbDbserverVmTagArgs.builder()
        .entityId("string")
        .entityType("string")
        .tagId("string")
        .tagName("string")
        .value("string")
        .build())
    .timeMachineId("string")
    .timezone("string")
    .vmPassword("string")
    .build());

    ndb_dbserver_vm_resource = nutanix.NdbDbserverVm("ndbDbserverVmResource",
    compute_profile_id="string",
    nx_cluster_id="string",
    database_type="string",
    network_profile_id="string",
    delete_vm_snapshots=False,
    snapshot_id="string",
    description="string",
    latest_snapshot=False,
    maintenance_tasks={
        "maintenance_window_id": "string",
        "tasks": [{
            "post_command": "string",
            "pre_command": "string",
            "task_type": "string",
        }],
    },
    delete=False,
    credentials=[{
        "password": "string",
        "username": "string",
        "label": "string",
    }],
    postgres_databases=[{
        "vm_name": "string",
        "client_public_key": "string",
    }],
    remove=False,
    delete_vgs=False,
    soft_remove=False,
    software_profile_id="string",
    software_profile_version_id="string",
    tags=[{
        "entity_id": "string",
        "entity_type": "string",
        "tag_id": "string",
        "tag_name": "string",
        "value": "string",
    }],
    time_machine_id="string",
    timezone="string",
    vm_password="string")

    const ndbDbserverVmResource = new nutanix.NdbDbserverVm("ndbDbserverVmResource", {
    computeProfileId: "string",
    nxClusterId: "string",
    databaseType: "string",
    networkProfileId: "string",
    deleteVmSnapshots: false,
    snapshotId: "string",
    description: "string",
    latestSnapshot: false,
    maintenanceTasks: {
        maintenanceWindowId: "string",
        tasks: [{
            postCommand: "string",
            preCommand: "string",
            taskType: "string",
        }],
    },
    "delete": false,
    credentials: [{
        password: "string",
        username: "string",
        label: "string",
    }],
    postgresDatabases: [{
        vmName: "string",
        clientPublicKey: "string",
    }],
    remove: false,
    deleteVgs: false,
    softRemove: false,
    softwareProfileId: "string",
    softwareProfileVersionId: "string",
    tags: [{
        entityId: "string",
        entityType: "string",
        tagId: "string",
        tagName: "string",
        value: "string",
    }],
    timeMachineId: "string",
    timezone: "string",
    vmPassword: "string",
});

    type: nutanix:NdbDbserverVm
properties:
    computeProfileId: string
    credentials:
        - label: string
          password: string
          username: string
    databaseType: string
    delete: false
    deleteVgs: false
    deleteVmSnapshots: false
    description: string
    latestSnapshot: false
    maintenanceTasks:
        maintenanceWindowId: string
        tasks:
            - postCommand: string
              preCommand: string
              taskType: string
    networkProfileId: string
    nxClusterId: string
    postgresDatabases:
        - clientPublicKey: string
          vmName: string
    remove: false
    snapshotId: string
    softRemove: false
    softwareProfileId: string
    softwareProfileVersionId: string
    tags:
        - entityId: string
          entityType: string
          tagId: string
          tagName: string
          value: string
    timeMachineId: string
    timezone: string
    vmPassword: string

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

    ComputeProfileId string
    Compute profile id.
    DatabaseType string
    database type. Valid values: postgres_database
    NetworkProfileId string
    Network profile id.
    NxClusterId string
    Credentials List<PiersKarsenbarg.Nutanix.Inputs.NdbDbserverVmCredential>
    Delete bool
    • (Optional) Delete the VM and associated storage. Default value is true
    DeleteVgs bool
    • (Optional) Delete volume grous. Default value is true
    DeleteVmSnapshots bool
    • (Optional) Delete the vm snapshots. Default is true
    Description string
    Type a description for the database server VM.
    LatestSnapshot bool
    MaintenanceTasks PiersKarsenbarg.Nutanix.Inputs.NdbDbserverVmMaintenanceTasks
    maintenance window configured to enable automated patching.
    PostgresDatabases List<PiersKarsenbarg.Nutanix.Inputs.NdbDbserverVmPostgresDatabase>
    Postgres database server vm
    Remove bool
    • (Optional) Unregister the database from NDB. Default value is false
    SnapshotId string
    Snapshot id. If not given, it will use latest snapshot to provision db server vm.
    SoftRemove bool
    • (Optional) Soft remove. Default will be false
    SoftwareProfileId string
    software profile id you want to provision a database server VM from an existing software profile.Required with software_profile_version_id. Conflicts with time_machine_id .
    SoftwareProfileVersionId string
    SOftware Profile Version Id.
    Tags List<PiersKarsenbarg.Nutanix.Inputs.NdbDbserverVmTag>
    TimeMachineId string
    Time Machine id you want to provision a database server VM by using the database and operating system software stored in a time machine. Conflicts with software_profile_id.
    Timezone string
    VmPassword string
    password of the NDB drive user account.
    ComputeProfileId string
    Compute profile id.
    DatabaseType string
    database type. Valid values: postgres_database
    NetworkProfileId string
    Network profile id.
    NxClusterId string
    Credentials []NdbDbserverVmCredentialArgs
    Delete bool
    • (Optional) Delete the VM and associated storage. Default value is true
    DeleteVgs bool
    • (Optional) Delete volume grous. Default value is true
    DeleteVmSnapshots bool
    • (Optional) Delete the vm snapshots. Default is true
    Description string
    Type a description for the database server VM.
    LatestSnapshot bool
    MaintenanceTasks NdbDbserverVmMaintenanceTasksArgs
    maintenance window configured to enable automated patching.
    PostgresDatabases []NdbDbserverVmPostgresDatabaseArgs
    Postgres database server vm
    Remove bool
    • (Optional) Unregister the database from NDB. Default value is false
    SnapshotId string
    Snapshot id. If not given, it will use latest snapshot to provision db server vm.
    SoftRemove bool
    • (Optional) Soft remove. Default will be false
    SoftwareProfileId string
    software profile id you want to provision a database server VM from an existing software profile.Required with software_profile_version_id. Conflicts with time_machine_id .
    SoftwareProfileVersionId string
    SOftware Profile Version Id.
    Tags []NdbDbserverVmTagArgs
    TimeMachineId string
    Time Machine id you want to provision a database server VM by using the database and operating system software stored in a time machine. Conflicts with software_profile_id.
    Timezone string
    VmPassword string
    password of the NDB drive user account.
    computeProfileId String
    Compute profile id.
    databaseType String
    database type. Valid values: postgres_database
    networkProfileId String
    Network profile id.
    nxClusterId String
    credentials List<NdbDbserverVmCredential>
    delete Boolean
    • (Optional) Delete the VM and associated storage. Default value is true
    deleteVgs Boolean
    • (Optional) Delete volume grous. Default value is true
    deleteVmSnapshots Boolean
    • (Optional) Delete the vm snapshots. Default is true
    description String
    Type a description for the database server VM.
    latestSnapshot Boolean
    maintenanceTasks NdbDbserverVmMaintenanceTasks
    maintenance window configured to enable automated patching.
    postgresDatabases List<NdbDbserverVmPostgresDatabase>
    Postgres database server vm
    remove Boolean
    • (Optional) Unregister the database from NDB. Default value is false
    snapshotId String
    Snapshot id. If not given, it will use latest snapshot to provision db server vm.
    softRemove Boolean
    • (Optional) Soft remove. Default will be false
    softwareProfileId String
    software profile id you want to provision a database server VM from an existing software profile.Required with software_profile_version_id. Conflicts with time_machine_id .
    softwareProfileVersionId String
    SOftware Profile Version Id.
    tags List<NdbDbserverVmTag>
    timeMachineId String
    Time Machine id you want to provision a database server VM by using the database and operating system software stored in a time machine. Conflicts with software_profile_id.
    timezone String
    vmPassword String
    password of the NDB drive user account.
    computeProfileId string
    Compute profile id.
    databaseType string
    database type. Valid values: postgres_database
    networkProfileId string
    Network profile id.
    nxClusterId string
    credentials NdbDbserverVmCredential[]
    delete boolean
    • (Optional) Delete the VM and associated storage. Default value is true
    deleteVgs boolean
    • (Optional) Delete volume grous. Default value is true
    deleteVmSnapshots boolean
    • (Optional) Delete the vm snapshots. Default is true
    description string
    Type a description for the database server VM.
    latestSnapshot boolean
    maintenanceTasks NdbDbserverVmMaintenanceTasks
    maintenance window configured to enable automated patching.
    postgresDatabases NdbDbserverVmPostgresDatabase[]
    Postgres database server vm
    remove boolean
    • (Optional) Unregister the database from NDB. Default value is false
    snapshotId string
    Snapshot id. If not given, it will use latest snapshot to provision db server vm.
    softRemove boolean
    • (Optional) Soft remove. Default will be false
    softwareProfileId string
    software profile id you want to provision a database server VM from an existing software profile.Required with software_profile_version_id. Conflicts with time_machine_id .
    softwareProfileVersionId string
    SOftware Profile Version Id.
    tags NdbDbserverVmTag[]
    timeMachineId string
    Time Machine id you want to provision a database server VM by using the database and operating system software stored in a time machine. Conflicts with software_profile_id.
    timezone string
    vmPassword string
    password of the NDB drive user account.
    compute_profile_id str
    Compute profile id.
    database_type str
    database type. Valid values: postgres_database
    network_profile_id str
    Network profile id.
    nx_cluster_id str
    credentials Sequence[NdbDbserverVmCredentialArgs]
    delete bool
    • (Optional) Delete the VM and associated storage. Default value is true
    delete_vgs bool
    • (Optional) Delete volume grous. Default value is true
    delete_vm_snapshots bool
    • (Optional) Delete the vm snapshots. Default is true
    description str
    Type a description for the database server VM.
    latest_snapshot bool
    maintenance_tasks NdbDbserverVmMaintenanceTasksArgs
    maintenance window configured to enable automated patching.
    postgres_databases Sequence[NdbDbserverVmPostgresDatabaseArgs]
    Postgres database server vm
    remove bool
    • (Optional) Unregister the database from NDB. Default value is false
    snapshot_id str
    Snapshot id. If not given, it will use latest snapshot to provision db server vm.
    soft_remove bool
    • (Optional) Soft remove. Default will be false
    software_profile_id str
    software profile id you want to provision a database server VM from an existing software profile.Required with software_profile_version_id. Conflicts with time_machine_id .
    software_profile_version_id str
    SOftware Profile Version Id.
    tags Sequence[NdbDbserverVmTagArgs]
    time_machine_id str
    Time Machine id you want to provision a database server VM by using the database and operating system software stored in a time machine. Conflicts with software_profile_id.
    timezone str
    vm_password str
    password of the NDB drive user account.
    computeProfileId String
    Compute profile id.
    databaseType String
    database type. Valid values: postgres_database
    networkProfileId String
    Network profile id.
    nxClusterId String
    credentials List<Property Map>
    delete Boolean
    • (Optional) Delete the VM and associated storage. Default value is true
    deleteVgs Boolean
    • (Optional) Delete volume grous. Default value is true
    deleteVmSnapshots Boolean
    • (Optional) Delete the vm snapshots. Default is true
    description String
    Type a description for the database server VM.
    latestSnapshot Boolean
    maintenanceTasks Property Map
    maintenance window configured to enable automated patching.
    postgresDatabases List<Property Map>
    Postgres database server vm
    remove Boolean
    • (Optional) Unregister the database from NDB. Default value is false
    snapshotId String
    Snapshot id. If not given, it will use latest snapshot to provision db server vm.
    softRemove Boolean
    • (Optional) Soft remove. Default will be false
    softwareProfileId String
    software profile id you want to provision a database server VM from an existing software profile.Required with software_profile_version_id. Conflicts with time_machine_id .
    softwareProfileVersionId String
    SOftware Profile Version Id.
    tags List<Property Map>
    timeMachineId String
    Time Machine id you want to provision a database server VM by using the database and operating system software stored in a time machine. Conflicts with software_profile_id.
    timezone String
    vmPassword String
    password of the NDB drive user account.

    Outputs

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

    ClientId string
    DbserverClusterId string
    EraDriveId string
    EraVersion string
    Fqdns string
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddresses List<string>
    MacAddresses List<string>
    Name string
    Properties List<PiersKarsenbarg.Nutanix.Outputs.NdbDbserverVmProperty>
    List of all the properties
    Status string
    Type string
    VmClusterName string
    VmClusterUuid string
    VmTimezone string
    ClientId string
    DbserverClusterId string
    EraDriveId string
    EraVersion string
    Fqdns string
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddresses []string
    MacAddresses []string
    Name string
    Properties []NdbDbserverVmProperty
    List of all the properties
    Status string
    Type string
    VmClusterName string
    VmClusterUuid string
    VmTimezone string
    clientId String
    dbserverClusterId String
    eraDriveId String
    eraVersion String
    fqdns String
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddresses List<String>
    macAddresses List<String>
    name String
    properties List<NdbDbserverVmProperty>
    List of all the properties
    status String
    type String
    vmClusterName String
    vmClusterUuid String
    vmTimezone String
    clientId string
    dbserverClusterId string
    eraDriveId string
    eraVersion string
    fqdns string
    id string
    The provider-assigned unique ID for this managed resource.
    ipAddresses string[]
    macAddresses string[]
    name string
    properties NdbDbserverVmProperty[]
    List of all the properties
    status string
    type string
    vmClusterName string
    vmClusterUuid string
    vmTimezone string
    client_id str
    dbserver_cluster_id str
    era_drive_id str
    era_version str
    fqdns str
    id str
    The provider-assigned unique ID for this managed resource.
    ip_addresses Sequence[str]
    mac_addresses Sequence[str]
    name str
    properties Sequence[NdbDbserverVmProperty]
    List of all the properties
    status str
    type str
    vm_cluster_name str
    vm_cluster_uuid str
    vm_timezone str
    clientId String
    dbserverClusterId String
    eraDriveId String
    eraVersion String
    fqdns String
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddresses List<String>
    macAddresses List<String>
    name String
    properties List<Property Map>
    List of all the properties
    status String
    type String
    vmClusterName String
    vmClusterUuid String
    vmTimezone String

    Look up Existing NdbDbserverVm Resource

    Get an existing NdbDbserverVm 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?: NdbDbserverVmState, opts?: CustomResourceOptions): NdbDbserverVm
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        compute_profile_id: Optional[str] = None,
        credentials: Optional[Sequence[NdbDbserverVmCredentialArgs]] = None,
        database_type: Optional[str] = None,
        dbserver_cluster_id: Optional[str] = None,
        delete: Optional[bool] = None,
        delete_vgs: Optional[bool] = None,
        delete_vm_snapshots: Optional[bool] = None,
        description: Optional[str] = None,
        era_drive_id: Optional[str] = None,
        era_version: Optional[str] = None,
        fqdns: Optional[str] = None,
        ip_addresses: Optional[Sequence[str]] = None,
        latest_snapshot: Optional[bool] = None,
        mac_addresses: Optional[Sequence[str]] = None,
        maintenance_tasks: Optional[NdbDbserverVmMaintenanceTasksArgs] = None,
        name: Optional[str] = None,
        network_profile_id: Optional[str] = None,
        nx_cluster_id: Optional[str] = None,
        postgres_databases: Optional[Sequence[NdbDbserverVmPostgresDatabaseArgs]] = None,
        properties: Optional[Sequence[NdbDbserverVmPropertyArgs]] = None,
        remove: Optional[bool] = None,
        snapshot_id: Optional[str] = None,
        soft_remove: Optional[bool] = None,
        software_profile_id: Optional[str] = None,
        software_profile_version_id: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[NdbDbserverVmTagArgs]] = None,
        time_machine_id: Optional[str] = None,
        timezone: Optional[str] = None,
        type: Optional[str] = None,
        vm_cluster_name: Optional[str] = None,
        vm_cluster_uuid: Optional[str] = None,
        vm_password: Optional[str] = None,
        vm_timezone: Optional[str] = None) -> NdbDbserverVm
    func GetNdbDbserverVm(ctx *Context, name string, id IDInput, state *NdbDbserverVmState, opts ...ResourceOption) (*NdbDbserverVm, error)
    public static NdbDbserverVm Get(string name, Input<string> id, NdbDbserverVmState? state, CustomResourceOptions? opts = null)
    public static NdbDbserverVm get(String name, Output<String> id, NdbDbserverVmState state, CustomResourceOptions options)
    resources:  _:    type: nutanix:NdbDbserverVm    get:      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:
    ClientId string
    ComputeProfileId string
    Compute profile id.
    Credentials List<PiersKarsenbarg.Nutanix.Inputs.NdbDbserverVmCredential>
    DatabaseType string
    database type. Valid values: postgres_database
    DbserverClusterId string
    Delete bool
    • (Optional) Delete the VM and associated storage. Default value is true
    DeleteVgs bool
    • (Optional) Delete volume grous. Default value is true
    DeleteVmSnapshots bool
    • (Optional) Delete the vm snapshots. Default is true
    Description string
    Type a description for the database server VM.
    EraDriveId string
    EraVersion string
    Fqdns string
    IpAddresses List<string>
    LatestSnapshot bool
    MacAddresses List<string>
    MaintenanceTasks PiersKarsenbarg.Nutanix.Inputs.NdbDbserverVmMaintenanceTasks
    maintenance window configured to enable automated patching.
    Name string
    NetworkProfileId string
    Network profile id.
    NxClusterId string
    PostgresDatabases List<PiersKarsenbarg.Nutanix.Inputs.NdbDbserverVmPostgresDatabase>
    Postgres database server vm
    Properties List<PiersKarsenbarg.Nutanix.Inputs.NdbDbserverVmProperty>
    List of all the properties
    Remove bool
    • (Optional) Unregister the database from NDB. Default value is false
    SnapshotId string
    Snapshot id. If not given, it will use latest snapshot to provision db server vm.
    SoftRemove bool
    • (Optional) Soft remove. Default will be false
    SoftwareProfileId string
    software profile id you want to provision a database server VM from an existing software profile.Required with software_profile_version_id. Conflicts with time_machine_id .
    SoftwareProfileVersionId string
    SOftware Profile Version Id.
    Status string
    Tags List<PiersKarsenbarg.Nutanix.Inputs.NdbDbserverVmTag>
    TimeMachineId string
    Time Machine id you want to provision a database server VM by using the database and operating system software stored in a time machine. Conflicts with software_profile_id.
    Timezone string
    Type string
    VmClusterName string
    VmClusterUuid string
    VmPassword string
    password of the NDB drive user account.
    VmTimezone string
    ClientId string
    ComputeProfileId string
    Compute profile id.
    Credentials []NdbDbserverVmCredentialArgs
    DatabaseType string
    database type. Valid values: postgres_database
    DbserverClusterId string
    Delete bool
    • (Optional) Delete the VM and associated storage. Default value is true
    DeleteVgs bool
    • (Optional) Delete volume grous. Default value is true
    DeleteVmSnapshots bool
    • (Optional) Delete the vm snapshots. Default is true
    Description string
    Type a description for the database server VM.
    EraDriveId string
    EraVersion string
    Fqdns string
    IpAddresses []string
    LatestSnapshot bool
    MacAddresses []string
    MaintenanceTasks NdbDbserverVmMaintenanceTasksArgs
    maintenance window configured to enable automated patching.
    Name string
    NetworkProfileId string
    Network profile id.
    NxClusterId string
    PostgresDatabases []NdbDbserverVmPostgresDatabaseArgs
    Postgres database server vm
    Properties []NdbDbserverVmPropertyArgs
    List of all the properties
    Remove bool
    • (Optional) Unregister the database from NDB. Default value is false
    SnapshotId string
    Snapshot id. If not given, it will use latest snapshot to provision db server vm.
    SoftRemove bool
    • (Optional) Soft remove. Default will be false
    SoftwareProfileId string
    software profile id you want to provision a database server VM from an existing software profile.Required with software_profile_version_id. Conflicts with time_machine_id .
    SoftwareProfileVersionId string
    SOftware Profile Version Id.
    Status string
    Tags []NdbDbserverVmTagArgs
    TimeMachineId string
    Time Machine id you want to provision a database server VM by using the database and operating system software stored in a time machine. Conflicts with software_profile_id.
    Timezone string
    Type string
    VmClusterName string
    VmClusterUuid string
    VmPassword string
    password of the NDB drive user account.
    VmTimezone string
    clientId String
    computeProfileId String
    Compute profile id.
    credentials List<NdbDbserverVmCredential>
    databaseType String
    database type. Valid values: postgres_database
    dbserverClusterId String
    delete Boolean
    • (Optional) Delete the VM and associated storage. Default value is true
    deleteVgs Boolean
    • (Optional) Delete volume grous. Default value is true
    deleteVmSnapshots Boolean
    • (Optional) Delete the vm snapshots. Default is true
    description String
    Type a description for the database server VM.
    eraDriveId String
    eraVersion String
    fqdns String
    ipAddresses List<String>
    latestSnapshot Boolean
    macAddresses List<String>
    maintenanceTasks NdbDbserverVmMaintenanceTasks
    maintenance window configured to enable automated patching.
    name String
    networkProfileId String
    Network profile id.
    nxClusterId String
    postgresDatabases List<NdbDbserverVmPostgresDatabase>
    Postgres database server vm
    properties List<NdbDbserverVmProperty>
    List of all the properties
    remove Boolean
    • (Optional) Unregister the database from NDB. Default value is false
    snapshotId String
    Snapshot id. If not given, it will use latest snapshot to provision db server vm.
    softRemove Boolean
    • (Optional) Soft remove. Default will be false
    softwareProfileId String
    software profile id you want to provision a database server VM from an existing software profile.Required with software_profile_version_id. Conflicts with time_machine_id .
    softwareProfileVersionId String
    SOftware Profile Version Id.
    status String
    tags List<NdbDbserverVmTag>
    timeMachineId String
    Time Machine id you want to provision a database server VM by using the database and operating system software stored in a time machine. Conflicts with software_profile_id.
    timezone String
    type String
    vmClusterName String
    vmClusterUuid String
    vmPassword String
    password of the NDB drive user account.
    vmTimezone String
    clientId string
    computeProfileId string
    Compute profile id.
    credentials NdbDbserverVmCredential[]
    databaseType string
    database type. Valid values: postgres_database
    dbserverClusterId string
    delete boolean
    • (Optional) Delete the VM and associated storage. Default value is true
    deleteVgs boolean
    • (Optional) Delete volume grous. Default value is true
    deleteVmSnapshots boolean
    • (Optional) Delete the vm snapshots. Default is true
    description string
    Type a description for the database server VM.
    eraDriveId string
    eraVersion string
    fqdns string
    ipAddresses string[]
    latestSnapshot boolean
    macAddresses string[]
    maintenanceTasks NdbDbserverVmMaintenanceTasks
    maintenance window configured to enable automated patching.
    name string
    networkProfileId string
    Network profile id.
    nxClusterId string
    postgresDatabases NdbDbserverVmPostgresDatabase[]
    Postgres database server vm
    properties NdbDbserverVmProperty[]
    List of all the properties
    remove boolean
    • (Optional) Unregister the database from NDB. Default value is false
    snapshotId string
    Snapshot id. If not given, it will use latest snapshot to provision db server vm.
    softRemove boolean
    • (Optional) Soft remove. Default will be false
    softwareProfileId string
    software profile id you want to provision a database server VM from an existing software profile.Required with software_profile_version_id. Conflicts with time_machine_id .
    softwareProfileVersionId string
    SOftware Profile Version Id.
    status string
    tags NdbDbserverVmTag[]
    timeMachineId string
    Time Machine id you want to provision a database server VM by using the database and operating system software stored in a time machine. Conflicts with software_profile_id.
    timezone string
    type string
    vmClusterName string
    vmClusterUuid string
    vmPassword string
    password of the NDB drive user account.
    vmTimezone string
    client_id str
    compute_profile_id str
    Compute profile id.
    credentials Sequence[NdbDbserverVmCredentialArgs]
    database_type str
    database type. Valid values: postgres_database
    dbserver_cluster_id str
    delete bool
    • (Optional) Delete the VM and associated storage. Default value is true
    delete_vgs bool
    • (Optional) Delete volume grous. Default value is true
    delete_vm_snapshots bool
    • (Optional) Delete the vm snapshots. Default is true
    description str
    Type a description for the database server VM.
    era_drive_id str
    era_version str
    fqdns str
    ip_addresses Sequence[str]
    latest_snapshot bool
    mac_addresses Sequence[str]
    maintenance_tasks NdbDbserverVmMaintenanceTasksArgs
    maintenance window configured to enable automated patching.
    name str
    network_profile_id str
    Network profile id.
    nx_cluster_id str
    postgres_databases Sequence[NdbDbserverVmPostgresDatabaseArgs]
    Postgres database server vm
    properties Sequence[NdbDbserverVmPropertyArgs]
    List of all the properties
    remove bool
    • (Optional) Unregister the database from NDB. Default value is false
    snapshot_id str
    Snapshot id. If not given, it will use latest snapshot to provision db server vm.
    soft_remove bool
    • (Optional) Soft remove. Default will be false
    software_profile_id str
    software profile id you want to provision a database server VM from an existing software profile.Required with software_profile_version_id. Conflicts with time_machine_id .
    software_profile_version_id str
    SOftware Profile Version Id.
    status str
    tags Sequence[NdbDbserverVmTagArgs]
    time_machine_id str
    Time Machine id you want to provision a database server VM by using the database and operating system software stored in a time machine. Conflicts with software_profile_id.
    timezone str
    type str
    vm_cluster_name str
    vm_cluster_uuid str
    vm_password str
    password of the NDB drive user account.
    vm_timezone str
    clientId String
    computeProfileId String
    Compute profile id.
    credentials List<Property Map>
    databaseType String
    database type. Valid values: postgres_database
    dbserverClusterId String
    delete Boolean
    • (Optional) Delete the VM and associated storage. Default value is true
    deleteVgs Boolean
    • (Optional) Delete volume grous. Default value is true
    deleteVmSnapshots Boolean
    • (Optional) Delete the vm snapshots. Default is true
    description String
    Type a description for the database server VM.
    eraDriveId String
    eraVersion String
    fqdns String
    ipAddresses List<String>
    latestSnapshot Boolean
    macAddresses List<String>
    maintenanceTasks Property Map
    maintenance window configured to enable automated patching.
    name String
    networkProfileId String
    Network profile id.
    nxClusterId String
    postgresDatabases List<Property Map>
    Postgres database server vm
    properties List<Property Map>
    List of all the properties
    remove Boolean
    • (Optional) Unregister the database from NDB. Default value is false
    snapshotId String
    Snapshot id. If not given, it will use latest snapshot to provision db server vm.
    softRemove Boolean
    • (Optional) Soft remove. Default will be false
    softwareProfileId String
    software profile id you want to provision a database server VM from an existing software profile.Required with software_profile_version_id. Conflicts with time_machine_id .
    softwareProfileVersionId String
    SOftware Profile Version Id.
    status String
    tags List<Property Map>
    timeMachineId String
    Time Machine id you want to provision a database server VM by using the database and operating system software stored in a time machine. Conflicts with software_profile_id.
    timezone String
    type String
    vmClusterName String
    vmClusterUuid String
    vmPassword String
    password of the NDB drive user account.
    vmTimezone String

    Supporting Types

    NdbDbserverVmCredential, NdbDbserverVmCredentialArgs

    Password string
    Username string
    Label string
    Password string
    Username string
    Label string
    password String
    username String
    label String
    password string
    username string
    label string
    password String
    username String
    label String

    NdbDbserverVmMaintenanceTasks, NdbDbserverVmMaintenanceTasksArgs

    MaintenanceWindowId string
    Associate an existing maintenance window id. NDB starts OS patching or database patching as per the schedule defined in the maintenance window.
    Tasks List<PiersKarsenbarg.Nutanix.Inputs.NdbDbserverVmMaintenanceTasksTask>
    Tasks for the maintenance.

    • tasks.task_type: use this option if you want NDB to perform database patching or OS patching automatically. Supports [ OS_PATCHING, DB_PATCHING ].
    • tasks.pre_command: add pre (operating system and database patching) commands.
    • tasks.post_command:add post (operating system and database patching) commands.
    MaintenanceWindowId string
    Associate an existing maintenance window id. NDB starts OS patching or database patching as per the schedule defined in the maintenance window.
    Tasks []NdbDbserverVmMaintenanceTasksTask
    Tasks for the maintenance.

    • tasks.task_type: use this option if you want NDB to perform database patching or OS patching automatically. Supports [ OS_PATCHING, DB_PATCHING ].
    • tasks.pre_command: add pre (operating system and database patching) commands.
    • tasks.post_command:add post (operating system and database patching) commands.
    maintenanceWindowId String
    Associate an existing maintenance window id. NDB starts OS patching or database patching as per the schedule defined in the maintenance window.
    tasks List<NdbDbserverVmMaintenanceTasksTask>
    Tasks for the maintenance.

    • tasks.task_type: use this option if you want NDB to perform database patching or OS patching automatically. Supports [ OS_PATCHING, DB_PATCHING ].
    • tasks.pre_command: add pre (operating system and database patching) commands.
    • tasks.post_command:add post (operating system and database patching) commands.
    maintenanceWindowId string
    Associate an existing maintenance window id. NDB starts OS patching or database patching as per the schedule defined in the maintenance window.
    tasks NdbDbserverVmMaintenanceTasksTask[]
    Tasks for the maintenance.

    • tasks.task_type: use this option if you want NDB to perform database patching or OS patching automatically. Supports [ OS_PATCHING, DB_PATCHING ].
    • tasks.pre_command: add pre (operating system and database patching) commands.
    • tasks.post_command:add post (operating system and database patching) commands.
    maintenance_window_id str
    Associate an existing maintenance window id. NDB starts OS patching or database patching as per the schedule defined in the maintenance window.
    tasks Sequence[NdbDbserverVmMaintenanceTasksTask]
    Tasks for the maintenance.

    • tasks.task_type: use this option if you want NDB to perform database patching or OS patching automatically. Supports [ OS_PATCHING, DB_PATCHING ].
    • tasks.pre_command: add pre (operating system and database patching) commands.
    • tasks.post_command:add post (operating system and database patching) commands.
    maintenanceWindowId String
    Associate an existing maintenance window id. NDB starts OS patching or database patching as per the schedule defined in the maintenance window.
    tasks List<Property Map>
    Tasks for the maintenance.

    • tasks.task_type: use this option if you want NDB to perform database patching or OS patching automatically. Supports [ OS_PATCHING, DB_PATCHING ].
    • tasks.pre_command: add pre (operating system and database patching) commands.
    • tasks.post_command:add post (operating system and database patching) commands.

    NdbDbserverVmMaintenanceTasksTask, NdbDbserverVmMaintenanceTasksTaskArgs

    PostCommand string
    PreCommand string
    TaskType string
    PostCommand string
    PreCommand string
    TaskType string
    postCommand String
    preCommand String
    taskType String
    postCommand string
    preCommand string
    taskType string
    postCommand String
    preCommand String
    taskType String

    NdbDbserverVmPostgresDatabase, NdbDbserverVmPostgresDatabaseArgs

    VmName string
    name for the database server VM.
    ClientPublicKey string
    use SSH public keys to access the database server VM.
    VmName string
    name for the database server VM.
    ClientPublicKey string
    use SSH public keys to access the database server VM.
    vmName String
    name for the database server VM.
    clientPublicKey String
    use SSH public keys to access the database server VM.
    vmName string
    name for the database server VM.
    clientPublicKey string
    use SSH public keys to access the database server VM.
    vm_name str
    name for the database server VM.
    client_public_key str
    use SSH public keys to access the database server VM.
    vmName String
    name for the database server VM.
    clientPublicKey String
    use SSH public keys to access the database server VM.

    NdbDbserverVmProperty, NdbDbserverVmPropertyArgs

    Name string
    name of the dbserver vm
    Value string
    Name string
    name of the dbserver vm
    Value string
    name String
    name of the dbserver vm
    value String
    name string
    name of the dbserver vm
    value string
    name str
    name of the dbserver vm
    value str
    name String
    name of the dbserver vm
    value String

    NdbDbserverVmTag, NdbDbserverVmTagArgs

    EntityId string
    EntityType string
    TagId string
    TagName string
    Value string
    EntityId string
    EntityType string
    TagId string
    TagName string
    Value string
    entityId String
    entityType String
    tagId String
    tagName String
    value String
    entityId string
    entityType string
    tagId string
    tagName string
    value string
    entityId String
    entityType String
    tagId String
    tagName String
    value String

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
    pierskarsenbarg/pulumi-nutanix