Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nutanix
  3. API Docs
  4. NdbRegisterDbserver
Nutanix v0.1.0 published on Tuesday, Sep 24, 2024 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

nutanix.NdbRegisterDbserver

Explore with Pulumi AI

nutanix logo
Nutanix v0.1.0 published on Tuesday, Sep 24, 2024 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

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

    Create NdbRegisterDbserver Resource

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

    Constructor syntax

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

@overload
def NdbRegisterDbserver(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        vm_ip: Optional[str] = None,
                        database_type: Optional[str] = None,
                        nxcluster_id: Optional[str] = None,
                        remove: Optional[bool] = None,
                        delete_vm_snapshots: Optional[bool] = None,
                        description: Optional[str] = None,
                        forced_install: Optional[bool] = None,
                        name: Optional[str] = None,
                        credentials: Optional[Sequence[NdbRegisterDbserverCredentialArgs]] = None,
                        password: Optional[str] = None,
                        postgres_databases: Optional[Sequence[NdbRegisterDbserverPostgresDatabaseArgs]] = None,
                        delete_vgs: Optional[bool] = None,
                        soft_remove: Optional[bool] = None,
                        ssh_key: Optional[str] = None,
                        tags: Optional[Sequence[NdbRegisterDbserverTagArgs]] = None,
                        update_name_description_in_cluster: Optional[bool] = None,
                        username: Optional[str] = None,
                        delete: Optional[bool] = None,
                        working_directory: Optional[str] = None)
    func NewNdbRegisterDbserver(ctx *Context, name string, args NdbRegisterDbserverArgs, opts ...ResourceOption) (*NdbRegisterDbserver, error)
    public NdbRegisterDbserver(string name, NdbRegisterDbserverArgs args, CustomResourceOptions? opts = null)
    public NdbRegisterDbserver(String name, NdbRegisterDbserverArgs args)
public NdbRegisterDbserver(String name, NdbRegisterDbserverArgs args, CustomResourceOptions options)

    type: nutanix:NdbRegisterDbserver
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 NdbRegisterDbserverArgs
    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 NdbRegisterDbserverArgs
    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 NdbRegisterDbserverArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NdbRegisterDbserverArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NdbRegisterDbserverArgs
    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 ndbRegisterDbserverResource = new Nutanix.NdbRegisterDbserver("ndbRegisterDbserverResource", new()
{
    VmIp = "string",
    DatabaseType = "string",
    NxclusterId = "string",
    Remove = false,
    DeleteVmSnapshots = false,
    Description = "string",
    ForcedInstall = false,
    Name = "string",
    Credentials = new[]
    {
        new Nutanix.Inputs.NdbRegisterDbserverCredentialArgs
        {
            Password = "string",
            Username = "string",
            Label = "string",
        },
    },
    Password = "string",
    PostgresDatabases = new[]
    {
        new Nutanix.Inputs.NdbRegisterDbserverPostgresDatabaseArgs
        {
            ListenerPort = "string",
            PostgresSoftwareHome = "string",
        },
    },
    DeleteVgs = false,
    SoftRemove = false,
    SshKey = "string",
    Tags = new[]
    {
        new Nutanix.Inputs.NdbRegisterDbserverTagArgs
        {
            EntityId = "string",
            EntityType = "string",
            TagId = "string",
            TagName = "string",
            Value = "string",
        },
    },
    UpdateNameDescriptionInCluster = false,
    Username = "string",
    Delete = false,
    WorkingDirectory = "string",
});

    example, err := nutanix.NewNdbRegisterDbserver(ctx, "ndbRegisterDbserverResource", &nutanix.NdbRegisterDbserverArgs{
	VmIp:              pulumi.String("string"),
	DatabaseType:      pulumi.String("string"),
	NxclusterId:       pulumi.String("string"),
	Remove:            pulumi.Bool(false),
	DeleteVmSnapshots: pulumi.Bool(false),
	Description:       pulumi.String("string"),
	ForcedInstall:     pulumi.Bool(false),
	Name:              pulumi.String("string"),
	Credentials: nutanix.NdbRegisterDbserverCredentialArray{
		&nutanix.NdbRegisterDbserverCredentialArgs{
			Password: pulumi.String("string"),
			Username: pulumi.String("string"),
			Label:    pulumi.String("string"),
		},
	},
	Password: pulumi.String("string"),
	PostgresDatabases: nutanix.NdbRegisterDbserverPostgresDatabaseArray{
		&nutanix.NdbRegisterDbserverPostgresDatabaseArgs{
			ListenerPort:         pulumi.String("string"),
			PostgresSoftwareHome: pulumi.String("string"),
		},
	},
	DeleteVgs:  pulumi.Bool(false),
	SoftRemove: pulumi.Bool(false),
	SshKey:     pulumi.String("string"),
	Tags: nutanix.NdbRegisterDbserverTagArray{
		&nutanix.NdbRegisterDbserverTagArgs{
			EntityId:   pulumi.String("string"),
			EntityType: pulumi.String("string"),
			TagId:      pulumi.String("string"),
			TagName:    pulumi.String("string"),
			Value:      pulumi.String("string"),
		},
	},
	UpdateNameDescriptionInCluster: pulumi.Bool(false),
	Username:                       pulumi.String("string"),
	Delete:                         pulumi.Bool(false),
	WorkingDirectory:               pulumi.String("string"),
})

    var ndbRegisterDbserverResource = new NdbRegisterDbserver("ndbRegisterDbserverResource", NdbRegisterDbserverArgs.builder()
    .vmIp("string")
    .databaseType("string")
    .nxclusterId("string")
    .remove(false)
    .deleteVmSnapshots(false)
    .description("string")
    .forcedInstall(false)
    .name("string")
    .credentials(NdbRegisterDbserverCredentialArgs.builder()
        .password("string")
        .username("string")
        .label("string")
        .build())
    .password("string")
    .postgresDatabases(NdbRegisterDbserverPostgresDatabaseArgs.builder()
        .listenerPort("string")
        .postgresSoftwareHome("string")
        .build())
    .deleteVgs(false)
    .softRemove(false)
    .sshKey("string")
    .tags(NdbRegisterDbserverTagArgs.builder()
        .entityId("string")
        .entityType("string")
        .tagId("string")
        .tagName("string")
        .value("string")
        .build())
    .updateNameDescriptionInCluster(false)
    .username("string")
    .delete(false)
    .workingDirectory("string")
    .build());

    ndb_register_dbserver_resource = nutanix.NdbRegisterDbserver("ndbRegisterDbserverResource",
    vm_ip="string",
    database_type="string",
    nxcluster_id="string",
    remove=False,
    delete_vm_snapshots=False,
    description="string",
    forced_install=False,
    name="string",
    credentials=[nutanix.NdbRegisterDbserverCredentialArgs(
        password="string",
        username="string",
        label="string",
    )],
    password="string",
    postgres_databases=[nutanix.NdbRegisterDbserverPostgresDatabaseArgs(
        listener_port="string",
        postgres_software_home="string",
    )],
    delete_vgs=False,
    soft_remove=False,
    ssh_key="string",
    tags=[nutanix.NdbRegisterDbserverTagArgs(
        entity_id="string",
        entity_type="string",
        tag_id="string",
        tag_name="string",
        value="string",
    )],
    update_name_description_in_cluster=False,
    username="string",
    delete=False,
    working_directory="string")

    const ndbRegisterDbserverResource = new nutanix.NdbRegisterDbserver("ndbRegisterDbserverResource", {
    vmIp: "string",
    databaseType: "string",
    nxclusterId: "string",
    remove: false,
    deleteVmSnapshots: false,
    description: "string",
    forcedInstall: false,
    name: "string",
    credentials: [{
        password: "string",
        username: "string",
        label: "string",
    }],
    password: "string",
    postgresDatabases: [{
        listenerPort: "string",
        postgresSoftwareHome: "string",
    }],
    deleteVgs: false,
    softRemove: false,
    sshKey: "string",
    tags: [{
        entityId: "string",
        entityType: "string",
        tagId: "string",
        tagName: "string",
        value: "string",
    }],
    updateNameDescriptionInCluster: false,
    username: "string",
    "delete": false,
    workingDirectory: "string",
});

    type: nutanix:NdbRegisterDbserver
properties:
    credentials:
        - label: string
          password: string
          username: string
    databaseType: string
    delete: false
    deleteVgs: false
    deleteVmSnapshots: false
    description: string
    forcedInstall: false
    name: string
    nxclusterId: string
    password: string
    postgresDatabases:
        - listenerPort: string
          postgresSoftwareHome: string
    remove: false
    softRemove: false
    sshKey: string
    tags:
        - entityId: string
          entityType: string
          tagId: string
          tagName: string
          value: string
    updateNameDescriptionInCluster: false
    username: string
    vmIp: string
    workingDirectory: string

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

    DatabaseType string
    database type i.e. postgres_database
    VmIp string
    IP address of the database server VM
    Credentials List<PiersKarsenbarg.Nutanix.Inputs.NdbRegisterDbserverCredential>
    Delete bool
    • (Optional) Delete the VM and associated storage. Default value is false
    DeleteVgs bool
    • (Optional) Delete volume grous. Default value is true
    DeleteVmSnapshots bool
    • (Optional) Delete the vm snapshots. Default is true
    Description string
    description of db server vm. Should be used in update Method only .
    ForcedInstall bool
    forced install the packages. Default is true
    Name string
    Name of db server vm. Should be used in Update Method only.
    NxclusterId string
    cluster on which you want to register the database server VM.
    Password string
    password of the NDB drive user account. Conflicts with ssh_key.
    PostgresDatabases List<PiersKarsenbarg.Nutanix.Inputs.NdbRegisterDbserverPostgresDatabase>
    postgres info for dbserver
    Remove bool
    • (Optional) Unregister the database from NDB. Default value is true
    SoftRemove bool
    • (Optional) Soft remove. Default will be false
    SshKey string
    the private key. Conflicts with password.
    Tags List<PiersKarsenbarg.Nutanix.Inputs.NdbRegisterDbserverTag>
    UpdateNameDescriptionInCluster bool
    Updates the name and description in cluster. Should be used in Update Method only.
    Username string
    username of the NDB drive user account that has sudo access
    WorkingDirectory string
    working directory of postgres. Default is "/tmp"
    DatabaseType string
    database type i.e. postgres_database
    VmIp string
    IP address of the database server VM
    Credentials []NdbRegisterDbserverCredentialArgs
    Delete bool
    • (Optional) Delete the VM and associated storage. Default value is false
    DeleteVgs bool
    • (Optional) Delete volume grous. Default value is true
    DeleteVmSnapshots bool
    • (Optional) Delete the vm snapshots. Default is true
    Description string
    description of db server vm. Should be used in update Method only .
    ForcedInstall bool
    forced install the packages. Default is true
    Name string
    Name of db server vm. Should be used in Update Method only.
    NxclusterId string
    cluster on which you want to register the database server VM.
    Password string
    password of the NDB drive user account. Conflicts with ssh_key.
    PostgresDatabases []NdbRegisterDbserverPostgresDatabaseArgs
    postgres info for dbserver
    Remove bool
    • (Optional) Unregister the database from NDB. Default value is true
    SoftRemove bool
    • (Optional) Soft remove. Default will be false
    SshKey string
    the private key. Conflicts with password.
    Tags []NdbRegisterDbserverTagArgs
    UpdateNameDescriptionInCluster bool
    Updates the name and description in cluster. Should be used in Update Method only.
    Username string
    username of the NDB drive user account that has sudo access
    WorkingDirectory string
    working directory of postgres. Default is "/tmp"
    databaseType String
    database type i.e. postgres_database
    vmIp String
    IP address of the database server VM
    credentials List<NdbRegisterDbserverCredential>
    delete Boolean
    • (Optional) Delete the VM and associated storage. Default value is false
    deleteVgs Boolean
    • (Optional) Delete volume grous. Default value is true
    deleteVmSnapshots Boolean
    • (Optional) Delete the vm snapshots. Default is true
    description String
    description of db server vm. Should be used in update Method only .
    forcedInstall Boolean
    forced install the packages. Default is true
    name String
    Name of db server vm. Should be used in Update Method only.
    nxclusterId String
    cluster on which you want to register the database server VM.
    password String
    password of the NDB drive user account. Conflicts with ssh_key.
    postgresDatabases List<NdbRegisterDbserverPostgresDatabase>
    postgres info for dbserver
    remove Boolean
    • (Optional) Unregister the database from NDB. Default value is true
    softRemove Boolean
    • (Optional) Soft remove. Default will be false
    sshKey String
    the private key. Conflicts with password.
    tags List<NdbRegisterDbserverTag>
    updateNameDescriptionInCluster Boolean
    Updates the name and description in cluster. Should be used in Update Method only.
    username String
    username of the NDB drive user account that has sudo access
    workingDirectory String
    working directory of postgres. Default is "/tmp"
    databaseType string
    database type i.e. postgres_database
    vmIp string
    IP address of the database server VM
    credentials NdbRegisterDbserverCredential[]
    delete boolean
    • (Optional) Delete the VM and associated storage. Default value is false
    deleteVgs boolean
    • (Optional) Delete volume grous. Default value is true
    deleteVmSnapshots boolean
    • (Optional) Delete the vm snapshots. Default is true
    description string
    description of db server vm. Should be used in update Method only .
    forcedInstall boolean
    forced install the packages. Default is true
    name string
    Name of db server vm. Should be used in Update Method only.
    nxclusterId string
    cluster on which you want to register the database server VM.
    password string
    password of the NDB drive user account. Conflicts with ssh_key.
    postgresDatabases NdbRegisterDbserverPostgresDatabase[]
    postgres info for dbserver
    remove boolean
    • (Optional) Unregister the database from NDB. Default value is true
    softRemove boolean
    • (Optional) Soft remove. Default will be false
    sshKey string
    the private key. Conflicts with password.
    tags NdbRegisterDbserverTag[]
    updateNameDescriptionInCluster boolean
    Updates the name and description in cluster. Should be used in Update Method only.
    username string
    username of the NDB drive user account that has sudo access
    workingDirectory string
    working directory of postgres. Default is "/tmp"
    database_type str
    database type i.e. postgres_database
    vm_ip str
    IP address of the database server VM
    credentials Sequence[NdbRegisterDbserverCredentialArgs]
    delete bool
    • (Optional) Delete the VM and associated storage. Default value is false
    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
    description of db server vm. Should be used in update Method only .
    forced_install bool
    forced install the packages. Default is true
    name str
    Name of db server vm. Should be used in Update Method only.
    nxcluster_id str
    cluster on which you want to register the database server VM.
    password str
    password of the NDB drive user account. Conflicts with ssh_key.
    postgres_databases Sequence[NdbRegisterDbserverPostgresDatabaseArgs]
    postgres info for dbserver
    remove bool
    • (Optional) Unregister the database from NDB. Default value is true
    soft_remove bool
    • (Optional) Soft remove. Default will be false
    ssh_key str
    the private key. Conflicts with password.
    tags Sequence[NdbRegisterDbserverTagArgs]
    update_name_description_in_cluster bool
    Updates the name and description in cluster. Should be used in Update Method only.
    username str
    username of the NDB drive user account that has sudo access
    working_directory str
    working directory of postgres. Default is "/tmp"
    databaseType String
    database type i.e. postgres_database
    vmIp String
    IP address of the database server VM
    credentials List<Property Map>
    delete Boolean
    • (Optional) Delete the VM and associated storage. Default value is false
    deleteVgs Boolean
    • (Optional) Delete volume grous. Default value is true
    deleteVmSnapshots Boolean
    • (Optional) Delete the vm snapshots. Default is true
    description String
    description of db server vm. Should be used in update Method only .
    forcedInstall Boolean
    forced install the packages. Default is true
    name String
    Name of db server vm. Should be used in Update Method only.
    nxclusterId String
    cluster on which you want to register the database server VM.
    password String
    password of the NDB drive user account. Conflicts with ssh_key.
    postgresDatabases List<Property Map>
    postgres info for dbserver
    remove Boolean
    • (Optional) Unregister the database from NDB. Default value is true
    softRemove Boolean
    • (Optional) Soft remove. Default will be false
    sshKey String
    the private key. Conflicts with password.
    tags List<Property Map>
    updateNameDescriptionInCluster Boolean
    Updates the name and description in cluster. Should be used in Update Method only.
    username String
    username of the NDB drive user account that has sudo access
    workingDirectory String
    working directory of postgres. Default is "/tmp"

    Outputs

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

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

    Look up Existing NdbRegisterDbserver Resource

    Get an existing NdbRegisterDbserver 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?: NdbRegisterDbserverState, opts?: CustomResourceOptions): NdbRegisterDbserver
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        credentials: Optional[Sequence[NdbRegisterDbserverCredentialArgs]] = 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_created: Optional[bool] = None,
        era_drive_id: Optional[str] = None,
        era_version: Optional[str] = None,
        forced_install: Optional[bool] = None,
        fqdns: Optional[str] = None,
        internal: Optional[bool] = None,
        ip_addresses: Optional[Sequence[str]] = None,
        mac_addresses: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        nxcluster_id: Optional[str] = None,
        password: Optional[str] = None,
        postgres_databases: Optional[Sequence[NdbRegisterDbserverPostgresDatabaseArgs]] = None,
        properties: Optional[Sequence[NdbRegisterDbserverPropertyArgs]] = None,
        remove: Optional[bool] = None,
        soft_remove: Optional[bool] = None,
        ssh_key: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[NdbRegisterDbserverTagArgs]] = None,
        type: Optional[str] = None,
        update_name_description_in_cluster: Optional[bool] = None,
        username: Optional[str] = None,
        vm_cluster_name: Optional[str] = None,
        vm_cluster_uuid: Optional[str] = None,
        vm_ip: Optional[str] = None,
        vm_timezone: Optional[str] = None,
        working_directory: Optional[str] = None) -> NdbRegisterDbserver
    func GetNdbRegisterDbserver(ctx *Context, name string, id IDInput, state *NdbRegisterDbserverState, opts ...ResourceOption) (*NdbRegisterDbserver, error)
    public static NdbRegisterDbserver Get(string name, Input<string> id, NdbRegisterDbserverState? state, CustomResourceOptions? opts = null)
    public static NdbRegisterDbserver get(String name, Output<String> id, NdbRegisterDbserverState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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
    Credentials List<PiersKarsenbarg.Nutanix.Inputs.NdbRegisterDbserverCredential>
    DatabaseType string
    database type i.e. postgres_database
    DbserverClusterId string
    Delete bool
    • (Optional) Delete the VM and associated storage. Default value is false
    DeleteVgs bool
    • (Optional) Delete volume grous. Default value is true
    DeleteVmSnapshots bool
    • (Optional) Delete the vm snapshots. Default is true
    Description string
    description of db server vm. Should be used in update Method only .
    EraCreated bool
    EraDriveId string
    EraVersion string
    ForcedInstall bool
    forced install the packages. Default is true
    Fqdns string
    Internal bool
    IpAddresses List<string>
    MacAddresses List<string>
    Name string
    Name of db server vm. Should be used in Update Method only.
    NxclusterId string
    cluster on which you want to register the database server VM.
    Password string
    password of the NDB drive user account. Conflicts with ssh_key.
    PostgresDatabases List<PiersKarsenbarg.Nutanix.Inputs.NdbRegisterDbserverPostgresDatabase>
    postgres info for dbserver
    Properties List<PiersKarsenbarg.Nutanix.Inputs.NdbRegisterDbserverProperty>
    List of all the properties
    Remove bool
    • (Optional) Unregister the database from NDB. Default value is true
    SoftRemove bool
    • (Optional) Soft remove. Default will be false
    SshKey string
    the private key. Conflicts with password.
    Status string
    Tags List<PiersKarsenbarg.Nutanix.Inputs.NdbRegisterDbserverTag>
    Type string
    UpdateNameDescriptionInCluster bool
    Updates the name and description in cluster. Should be used in Update Method only.
    Username string
    username of the NDB drive user account that has sudo access
    VmClusterName string
    VmClusterUuid string
    VmIp string
    IP address of the database server VM
    VmTimezone string
    WorkingDirectory string
    working directory of postgres. Default is "/tmp"
    ClientId string
    Credentials []NdbRegisterDbserverCredentialArgs
    DatabaseType string
    database type i.e. postgres_database
    DbserverClusterId string
    Delete bool
    • (Optional) Delete the VM and associated storage. Default value is false
    DeleteVgs bool
    • (Optional) Delete volume grous. Default value is true
    DeleteVmSnapshots bool
    • (Optional) Delete the vm snapshots. Default is true
    Description string
    description of db server vm. Should be used in update Method only .
    EraCreated bool
    EraDriveId string
    EraVersion string
    ForcedInstall bool
    forced install the packages. Default is true
    Fqdns string
    Internal bool
    IpAddresses []string
    MacAddresses []string
    Name string
    Name of db server vm. Should be used in Update Method only.
    NxclusterId string
    cluster on which you want to register the database server VM.
    Password string
    password of the NDB drive user account. Conflicts with ssh_key.
    PostgresDatabases []NdbRegisterDbserverPostgresDatabaseArgs
    postgres info for dbserver
    Properties []NdbRegisterDbserverPropertyArgs
    List of all the properties
    Remove bool
    • (Optional) Unregister the database from NDB. Default value is true
    SoftRemove bool
    • (Optional) Soft remove. Default will be false
    SshKey string
    the private key. Conflicts with password.
    Status string
    Tags []NdbRegisterDbserverTagArgs
    Type string
    UpdateNameDescriptionInCluster bool
    Updates the name and description in cluster. Should be used in Update Method only.
    Username string
    username of the NDB drive user account that has sudo access
    VmClusterName string
    VmClusterUuid string
    VmIp string
    IP address of the database server VM
    VmTimezone string
    WorkingDirectory string
    working directory of postgres. Default is "/tmp"
    clientId String
    credentials List<NdbRegisterDbserverCredential>
    databaseType String
    database type i.e. postgres_database
    dbserverClusterId String
    delete Boolean
    • (Optional) Delete the VM and associated storage. Default value is false
    deleteVgs Boolean
    • (Optional) Delete volume grous. Default value is true
    deleteVmSnapshots Boolean
    • (Optional) Delete the vm snapshots. Default is true
    description String
    description of db server vm. Should be used in update Method only .
    eraCreated Boolean
    eraDriveId String
    eraVersion String
    forcedInstall Boolean
    forced install the packages. Default is true
    fqdns String
    internal Boolean
    ipAddresses List<String>
    macAddresses List<String>
    name String
    Name of db server vm. Should be used in Update Method only.
    nxclusterId String
    cluster on which you want to register the database server VM.
    password String
    password of the NDB drive user account. Conflicts with ssh_key.
    postgresDatabases List<NdbRegisterDbserverPostgresDatabase>
    postgres info for dbserver
    properties List<NdbRegisterDbserverProperty>
    List of all the properties
    remove Boolean
    • (Optional) Unregister the database from NDB. Default value is true
    softRemove Boolean
    • (Optional) Soft remove. Default will be false
    sshKey String
    the private key. Conflicts with password.
    status String
    tags List<NdbRegisterDbserverTag>
    type String
    updateNameDescriptionInCluster Boolean
    Updates the name and description in cluster. Should be used in Update Method only.
    username String
    username of the NDB drive user account that has sudo access
    vmClusterName String
    vmClusterUuid String
    vmIp String
    IP address of the database server VM
    vmTimezone String
    workingDirectory String
    working directory of postgres. Default is "/tmp"
    clientId string
    credentials NdbRegisterDbserverCredential[]
    databaseType string
    database type i.e. postgres_database
    dbserverClusterId string
    delete boolean
    • (Optional) Delete the VM and associated storage. Default value is false
    deleteVgs boolean
    • (Optional) Delete volume grous. Default value is true
    deleteVmSnapshots boolean
    • (Optional) Delete the vm snapshots. Default is true
    description string
    description of db server vm. Should be used in update Method only .
    eraCreated boolean
    eraDriveId string
    eraVersion string
    forcedInstall boolean
    forced install the packages. Default is true
    fqdns string
    internal boolean
    ipAddresses string[]
    macAddresses string[]
    name string
    Name of db server vm. Should be used in Update Method only.
    nxclusterId string
    cluster on which you want to register the database server VM.
    password string
    password of the NDB drive user account. Conflicts with ssh_key.
    postgresDatabases NdbRegisterDbserverPostgresDatabase[]
    postgres info for dbserver
    properties NdbRegisterDbserverProperty[]
    List of all the properties
    remove boolean
    • (Optional) Unregister the database from NDB. Default value is true
    softRemove boolean
    • (Optional) Soft remove. Default will be false
    sshKey string
    the private key. Conflicts with password.
    status string
    tags NdbRegisterDbserverTag[]
    type string
    updateNameDescriptionInCluster boolean
    Updates the name and description in cluster. Should be used in Update Method only.
    username string
    username of the NDB drive user account that has sudo access
    vmClusterName string
    vmClusterUuid string
    vmIp string
    IP address of the database server VM
    vmTimezone string
    workingDirectory string
    working directory of postgres. Default is "/tmp"
    client_id str
    credentials Sequence[NdbRegisterDbserverCredentialArgs]
    database_type str
    database type i.e. postgres_database
    dbserver_cluster_id str
    delete bool
    • (Optional) Delete the VM and associated storage. Default value is false
    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
    description of db server vm. Should be used in update Method only .
    era_created bool
    era_drive_id str
    era_version str
    forced_install bool
    forced install the packages. Default is true
    fqdns str
    internal bool
    ip_addresses Sequence[str]
    mac_addresses Sequence[str]
    name str
    Name of db server vm. Should be used in Update Method only.
    nxcluster_id str
    cluster on which you want to register the database server VM.
    password str
    password of the NDB drive user account. Conflicts with ssh_key.
    postgres_databases Sequence[NdbRegisterDbserverPostgresDatabaseArgs]
    postgres info for dbserver
    properties Sequence[NdbRegisterDbserverPropertyArgs]
    List of all the properties
    remove bool
    • (Optional) Unregister the database from NDB. Default value is true
    soft_remove bool
    • (Optional) Soft remove. Default will be false
    ssh_key str
    the private key. Conflicts with password.
    status str
    tags Sequence[NdbRegisterDbserverTagArgs]
    type str
    update_name_description_in_cluster bool
    Updates the name and description in cluster. Should be used in Update Method only.
    username str
    username of the NDB drive user account that has sudo access
    vm_cluster_name str
    vm_cluster_uuid str
    vm_ip str
    IP address of the database server VM
    vm_timezone str
    working_directory str
    working directory of postgres. Default is "/tmp"
    clientId String
    credentials List<Property Map>
    databaseType String
    database type i.e. postgres_database
    dbserverClusterId String
    delete Boolean
    • (Optional) Delete the VM and associated storage. Default value is false
    deleteVgs Boolean
    • (Optional) Delete volume grous. Default value is true
    deleteVmSnapshots Boolean
    • (Optional) Delete the vm snapshots. Default is true
    description String
    description of db server vm. Should be used in update Method only .
    eraCreated Boolean
    eraDriveId String
    eraVersion String
    forcedInstall Boolean
    forced install the packages. Default is true
    fqdns String
    internal Boolean
    ipAddresses List<String>
    macAddresses List<String>
    name String
    Name of db server vm. Should be used in Update Method only.
    nxclusterId String
    cluster on which you want to register the database server VM.
    password String
    password of the NDB drive user account. Conflicts with ssh_key.
    postgresDatabases List<Property Map>
    postgres info for dbserver
    properties List<Property Map>
    List of all the properties
    remove Boolean
    • (Optional) Unregister the database from NDB. Default value is true
    softRemove Boolean
    • (Optional) Soft remove. Default will be false
    sshKey String
    the private key. Conflicts with password.
    status String
    tags List<Property Map>
    type String
    updateNameDescriptionInCluster Boolean
    Updates the name and description in cluster. Should be used in Update Method only.
    username String
    username of the NDB drive user account that has sudo access
    vmClusterName String
    vmClusterUuid String
    vmIp String
    IP address of the database server VM
    vmTimezone String
    workingDirectory String
    working directory of postgres. Default is "/tmp"

    Supporting Types

    NdbRegisterDbserverCredential, NdbRegisterDbserverCredentialArgs

    Password string
    password of the NDB drive user account. Conflicts with ssh_key.
    Username string
    username of the NDB drive user account that has sudo access
    Label string
    Password string
    password of the NDB drive user account. Conflicts with ssh_key.
    Username string
    username of the NDB drive user account that has sudo access
    Label string
    password String
    password of the NDB drive user account. Conflicts with ssh_key.
    username String
    username of the NDB drive user account that has sudo access
    label String
    password string
    password of the NDB drive user account. Conflicts with ssh_key.
    username string
    username of the NDB drive user account that has sudo access
    label string
    password str
    password of the NDB drive user account. Conflicts with ssh_key.
    username str
    username of the NDB drive user account that has sudo access
    label str
    password String
    password of the NDB drive user account. Conflicts with ssh_key.
    username String
    username of the NDB drive user account that has sudo access
    label String

    NdbRegisterDbserverPostgresDatabase, NdbRegisterDbserverPostgresDatabaseArgs

    ListenerPort string
    listener port of db server
    PostgresSoftwareHome string
    path to the PostgreSQL home directory in which the PostgreSQL software is installed
    ListenerPort string
    listener port of db server
    PostgresSoftwareHome string
    path to the PostgreSQL home directory in which the PostgreSQL software is installed
    listenerPort String
    listener port of db server
    postgresSoftwareHome String
    path to the PostgreSQL home directory in which the PostgreSQL software is installed
    listenerPort string
    listener port of db server
    postgresSoftwareHome string
    path to the PostgreSQL home directory in which the PostgreSQL software is installed
    listener_port str
    listener port of db server
    postgres_software_home str
    path to the PostgreSQL home directory in which the PostgreSQL software is installed
    listenerPort String
    listener port of db server
    postgresSoftwareHome String
    path to the PostgreSQL home directory in which the PostgreSQL software is installed

    NdbRegisterDbserverProperty, NdbRegisterDbserverPropertyArgs

    Name string
    Name of db server vm. Should be used in Update Method only.
    Value string
    Name string
    Name of db server vm. Should be used in Update Method only.
    Value string
    name String
    Name of db server vm. Should be used in Update Method only.
    value String
    name string
    Name of db server vm. Should be used in Update Method only.
    value string
    name str
    Name of db server vm. Should be used in Update Method only.
    value str
    name String
    Name of db server vm. Should be used in Update Method only.
    value String

    NdbRegisterDbserverTag, NdbRegisterDbserverTagArgs

    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.1.0 published on Tuesday, Sep 24, 2024 by Piers Karsenbarg
    pierskarsenbarg/pulumi-nutanix