1. Packages
  2. Ibm Provider
  3. API Docs
  4. BackupRecoverySourceRegistration
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.BackupRecoverySourceRegistration

Explore with Pulumi AI

Create, update, and delete backup_recovery_source_registrations with this resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const backupRecoverySourceRegistrationInstance = new ibm.BackupRecoverySourceRegistration("backupRecoverySourceRegistrationInstance", {
    advancedConfigs: [{
        key: "key",
        value: "value",
    }],
    connections: [{
        connectionId: "1",
        connectorGroupId: 1,
        dataSourceConnectionId: "data_source_connection_id",
        entityId: 1,
    }],
    environment: "kPhysical",
    physicalParams: {
        applications: ["kSQL"],
        endpoint: "endpoint",
        forceRegister: true,
        hostType: "kLinux",
        physicalType: "kGroup",
    },
    xIbmTenantId: "x_ibm_tenant_id",
});
Copy
import pulumi
import pulumi_ibm as ibm

backup_recovery_source_registration_instance = ibm.BackupRecoverySourceRegistration("backupRecoverySourceRegistrationInstance",
    advanced_configs=[{
        "key": "key",
        "value": "value",
    }],
    connections=[{
        "connection_id": "1",
        "connector_group_id": 1,
        "data_source_connection_id": "data_source_connection_id",
        "entity_id": 1,
    }],
    environment="kPhysical",
    physical_params={
        "applications": ["kSQL"],
        "endpoint": "endpoint",
        "force_register": True,
        "host_type": "kLinux",
        "physical_type": "kGroup",
    },
    x_ibm_tenant_id="x_ibm_tenant_id")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewBackupRecoverySourceRegistration(ctx, "backupRecoverySourceRegistrationInstance", &ibm.BackupRecoverySourceRegistrationArgs{
			AdvancedConfigs: ibm.BackupRecoverySourceRegistrationAdvancedConfigArray{
				&ibm.BackupRecoverySourceRegistrationAdvancedConfigArgs{
					Key:   pulumi.String("key"),
					Value: pulumi.String("value"),
				},
			},
			Connections: ibm.BackupRecoverySourceRegistrationConnectionArray{
				&ibm.BackupRecoverySourceRegistrationConnectionArgs{
					ConnectionId:           pulumi.String("1"),
					ConnectorGroupId:       pulumi.Float64(1),
					DataSourceConnectionId: pulumi.String("data_source_connection_id"),
					EntityId:               pulumi.Float64(1),
				},
			},
			Environment: pulumi.String("kPhysical"),
			PhysicalParams: &ibm.BackupRecoverySourceRegistrationPhysicalParamsArgs{
				Applications: pulumi.StringArray{
					pulumi.String("kSQL"),
				},
				Endpoint:      pulumi.String("endpoint"),
				ForceRegister: pulumi.Bool(true),
				HostType:      pulumi.String("kLinux"),
				PhysicalType:  pulumi.String("kGroup"),
			},
			XIbmTenantId: pulumi.String("x_ibm_tenant_id"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var backupRecoverySourceRegistrationInstance = new Ibm.BackupRecoverySourceRegistration("backupRecoverySourceRegistrationInstance", new()
    {
        AdvancedConfigs = new[]
        {
            new Ibm.Inputs.BackupRecoverySourceRegistrationAdvancedConfigArgs
            {
                Key = "key",
                Value = "value",
            },
        },
        Connections = new[]
        {
            new Ibm.Inputs.BackupRecoverySourceRegistrationConnectionArgs
            {
                ConnectionId = "1",
                ConnectorGroupId = 1,
                DataSourceConnectionId = "data_source_connection_id",
                EntityId = 1,
            },
        },
        Environment = "kPhysical",
        PhysicalParams = new Ibm.Inputs.BackupRecoverySourceRegistrationPhysicalParamsArgs
        {
            Applications = new[]
            {
                "kSQL",
            },
            Endpoint = "endpoint",
            ForceRegister = true,
            HostType = "kLinux",
            PhysicalType = "kGroup",
        },
        XIbmTenantId = "x_ibm_tenant_id",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.BackupRecoverySourceRegistration;
import com.pulumi.ibm.BackupRecoverySourceRegistrationArgs;
import com.pulumi.ibm.inputs.BackupRecoverySourceRegistrationAdvancedConfigArgs;
import com.pulumi.ibm.inputs.BackupRecoverySourceRegistrationConnectionArgs;
import com.pulumi.ibm.inputs.BackupRecoverySourceRegistrationPhysicalParamsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var backupRecoverySourceRegistrationInstance = new BackupRecoverySourceRegistration("backupRecoverySourceRegistrationInstance", BackupRecoverySourceRegistrationArgs.builder()
            .advancedConfigs(BackupRecoverySourceRegistrationAdvancedConfigArgs.builder()
                .key("key")
                .value("value")
                .build())
            .connections(BackupRecoverySourceRegistrationConnectionArgs.builder()
                .connectionId(1)
                .connectorGroupId(1)
                .dataSourceConnectionId("data_source_connection_id")
                .entityId(1)
                .build())
            .environment("kPhysical")
            .physicalParams(BackupRecoverySourceRegistrationPhysicalParamsArgs.builder()
                .applications("kSQL")
                .endpoint("endpoint")
                .forceRegister(true)
                .hostType("kLinux")
                .physicalType("kGroup")
                .build())
            .xIbmTenantId("x_ibm_tenant_id")
            .build());

    }
}
Copy
resources:
  backupRecoverySourceRegistrationInstance:
    type: ibm:BackupRecoverySourceRegistration
    properties:
      advancedConfigs:
        - key: key
          value: value
      connections:
        - connectionId: 1
          connectorGroupId: 1
          dataSourceConnectionId: data_source_connection_id
          entityId: 1
      environment: kPhysical
      physicalParams:
        applications:
          - kSQL
        endpoint: endpoint
        forceRegister: true
        hostType: kLinux
        physicalType: kGroup
      xIbmTenantId: x_ibm_tenant_id
Copy

Create BackupRecoverySourceRegistration Resource

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

Constructor syntax

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

@overload
def BackupRecoverySourceRegistration(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     environment: Optional[str] = None,
                                     x_ibm_tenant_id: Optional[str] = None,
                                     advanced_configs: Optional[Sequence[BackupRecoverySourceRegistrationAdvancedConfigArgs]] = None,
                                     backup_recovery_source_registration_id: Optional[str] = None,
                                     connection_id: Optional[str] = None,
                                     connections: Optional[Sequence[BackupRecoverySourceRegistrationConnectionArgs]] = None,
                                     connector_group_id: Optional[float] = None,
                                     data_source_connection_id: Optional[str] = None,
                                     encryption_key: Optional[str] = None,
                                     is_internal_encrypted: Optional[bool] = None,
                                     name: Optional[str] = None,
                                     physical_params: Optional[BackupRecoverySourceRegistrationPhysicalParamsArgs] = None)
func NewBackupRecoverySourceRegistration(ctx *Context, name string, args BackupRecoverySourceRegistrationArgs, opts ...ResourceOption) (*BackupRecoverySourceRegistration, error)
public BackupRecoverySourceRegistration(string name, BackupRecoverySourceRegistrationArgs args, CustomResourceOptions? opts = null)
public BackupRecoverySourceRegistration(String name, BackupRecoverySourceRegistrationArgs args)
public BackupRecoverySourceRegistration(String name, BackupRecoverySourceRegistrationArgs args, CustomResourceOptions options)
type: ibm:BackupRecoverySourceRegistration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BackupRecoverySourceRegistrationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BackupRecoverySourceRegistrationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BackupRecoverySourceRegistrationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BackupRecoverySourceRegistrationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BackupRecoverySourceRegistrationArgs
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 backupRecoverySourceRegistrationResource = new Ibm.BackupRecoverySourceRegistration("backupRecoverySourceRegistrationResource", new()
{
    Environment = "string",
    XIbmTenantId = "string",
    AdvancedConfigs = new[]
    {
        new Ibm.Inputs.BackupRecoverySourceRegistrationAdvancedConfigArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    BackupRecoverySourceRegistrationId = "string",
    ConnectionId = "string",
    Connections = new[]
    {
        new Ibm.Inputs.BackupRecoverySourceRegistrationConnectionArgs
        {
            ConnectionId = "string",
            ConnectorGroupId = 0,
            DataSourceConnectionId = "string",
            EntityId = 0,
        },
    },
    ConnectorGroupId = 0,
    DataSourceConnectionId = "string",
    EncryptionKey = "string",
    IsInternalEncrypted = false,
    Name = "string",
    PhysicalParams = new Ibm.Inputs.BackupRecoverySourceRegistrationPhysicalParamsArgs
    {
        Endpoint = "string",
        Applications = new[]
        {
            "string",
        },
        ForceRegister = false,
        HostType = "string",
        PhysicalType = "string",
    },
});
Copy
example, err := ibm.NewBackupRecoverySourceRegistration(ctx, "backupRecoverySourceRegistrationResource", &ibm.BackupRecoverySourceRegistrationArgs{
Environment: pulumi.String("string"),
XIbmTenantId: pulumi.String("string"),
AdvancedConfigs: .BackupRecoverySourceRegistrationAdvancedConfigArray{
&.BackupRecoverySourceRegistrationAdvancedConfigArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
BackupRecoverySourceRegistrationId: pulumi.String("string"),
ConnectionId: pulumi.String("string"),
Connections: .BackupRecoverySourceRegistrationConnectionArray{
&.BackupRecoverySourceRegistrationConnectionArgs{
ConnectionId: pulumi.String("string"),
ConnectorGroupId: pulumi.Float64(0),
DataSourceConnectionId: pulumi.String("string"),
EntityId: pulumi.Float64(0),
},
},
ConnectorGroupId: pulumi.Float64(0),
DataSourceConnectionId: pulumi.String("string"),
EncryptionKey: pulumi.String("string"),
IsInternalEncrypted: pulumi.Bool(false),
Name: pulumi.String("string"),
PhysicalParams: &.BackupRecoverySourceRegistrationPhysicalParamsArgs{
Endpoint: pulumi.String("string"),
Applications: pulumi.StringArray{
pulumi.String("string"),
},
ForceRegister: pulumi.Bool(false),
HostType: pulumi.String("string"),
PhysicalType: pulumi.String("string"),
},
})
Copy
var backupRecoverySourceRegistrationResource = new BackupRecoverySourceRegistration("backupRecoverySourceRegistrationResource", BackupRecoverySourceRegistrationArgs.builder()
    .environment("string")
    .xIbmTenantId("string")
    .advancedConfigs(BackupRecoverySourceRegistrationAdvancedConfigArgs.builder()
        .key("string")
        .value("string")
        .build())
    .backupRecoverySourceRegistrationId("string")
    .connectionId("string")
    .connections(BackupRecoverySourceRegistrationConnectionArgs.builder()
        .connectionId("string")
        .connectorGroupId(0)
        .dataSourceConnectionId("string")
        .entityId(0)
        .build())
    .connectorGroupId(0)
    .dataSourceConnectionId("string")
    .encryptionKey("string")
    .isInternalEncrypted(false)
    .name("string")
    .physicalParams(BackupRecoverySourceRegistrationPhysicalParamsArgs.builder()
        .endpoint("string")
        .applications("string")
        .forceRegister(false)
        .hostType("string")
        .physicalType("string")
        .build())
    .build());
Copy
backup_recovery_source_registration_resource = ibm.BackupRecoverySourceRegistration("backupRecoverySourceRegistrationResource",
    environment="string",
    x_ibm_tenant_id="string",
    advanced_configs=[{
        "key": "string",
        "value": "string",
    }],
    backup_recovery_source_registration_id="string",
    connection_id="string",
    connections=[{
        "connection_id": "string",
        "connector_group_id": 0,
        "data_source_connection_id": "string",
        "entity_id": 0,
    }],
    connector_group_id=0,
    data_source_connection_id="string",
    encryption_key="string",
    is_internal_encrypted=False,
    name="string",
    physical_params={
        "endpoint": "string",
        "applications": ["string"],
        "force_register": False,
        "host_type": "string",
        "physical_type": "string",
    })
Copy
const backupRecoverySourceRegistrationResource = new ibm.BackupRecoverySourceRegistration("backupRecoverySourceRegistrationResource", {
    environment: "string",
    xIbmTenantId: "string",
    advancedConfigs: [{
        key: "string",
        value: "string",
    }],
    backupRecoverySourceRegistrationId: "string",
    connectionId: "string",
    connections: [{
        connectionId: "string",
        connectorGroupId: 0,
        dataSourceConnectionId: "string",
        entityId: 0,
    }],
    connectorGroupId: 0,
    dataSourceConnectionId: "string",
    encryptionKey: "string",
    isInternalEncrypted: false,
    name: "string",
    physicalParams: {
        endpoint: "string",
        applications: ["string"],
        forceRegister: false,
        hostType: "string",
        physicalType: "string",
    },
});
Copy
type: ibm:BackupRecoverySourceRegistration
properties:
    advancedConfigs:
        - key: string
          value: string
    backupRecoverySourceRegistrationId: string
    connectionId: string
    connections:
        - connectionId: string
          connectorGroupId: 0
          dataSourceConnectionId: string
          entityId: 0
    connectorGroupId: 0
    dataSourceConnectionId: string
    encryptionKey: string
    environment: string
    isInternalEncrypted: false
    name: string
    physicalParams:
        applications:
            - string
        endpoint: string
        forceRegister: false
        hostType: string
        physicalType: string
    xIbmTenantId: string
Copy

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

Environment This property is required. string
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
XIbmTenantId This property is required. string
Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
AdvancedConfigs List<BackupRecoverySourceRegistrationAdvancedConfig>
Specifies the advanced configuration for a protection source. Nested schema for advanced_configs:
BackupRecoverySourceRegistrationId string
(String) The tenant id.
ConnectionId string
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. This field will be depricated in future. Use connections field.
Connections List<BackupRecoverySourceRegistrationConnection>
Specfies the list of connections for the source. Nested schema for connections:
ConnectorGroupId double
Specifies the connector group id of connector groups.
DataSourceConnectionId string
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. Also, this is the 'string' of connectionId. This property was added to accommodate for ID values that exceed 2^53 - 1, which is the max value for which JS maintains precision.
EncryptionKey string
Specifies the key that user has encrypted the credential with.
IsInternalEncrypted bool
Specifies if credentials are encrypted by internal key.
Name string
The user specified name for this source.
PhysicalParams BackupRecoverySourceRegistrationPhysicalParams
Specifies parameters to register physical server. Nested schema for physical_params:
Environment This property is required. string
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
XIbmTenantId This property is required. string
Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
AdvancedConfigs []BackupRecoverySourceRegistrationAdvancedConfigArgs
Specifies the advanced configuration for a protection source. Nested schema for advanced_configs:
BackupRecoverySourceRegistrationId string
(String) The tenant id.
ConnectionId string
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. This field will be depricated in future. Use connections field.
Connections []BackupRecoverySourceRegistrationConnectionArgs
Specfies the list of connections for the source. Nested schema for connections:
ConnectorGroupId float64
Specifies the connector group id of connector groups.
DataSourceConnectionId string
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. Also, this is the 'string' of connectionId. This property was added to accommodate for ID values that exceed 2^53 - 1, which is the max value for which JS maintains precision.
EncryptionKey string
Specifies the key that user has encrypted the credential with.
IsInternalEncrypted bool
Specifies if credentials are encrypted by internal key.
Name string
The user specified name for this source.
PhysicalParams BackupRecoverySourceRegistrationPhysicalParamsArgs
Specifies parameters to register physical server. Nested schema for physical_params:
environment This property is required. String
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
xIbmTenantId This property is required. String
Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
advancedConfigs List<BackupRecoverySourceRegistrationAdvancedConfig>
Specifies the advanced configuration for a protection source. Nested schema for advanced_configs:
backupRecoverySourceRegistrationId String
(String) The tenant id.
connectionId String
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. This field will be depricated in future. Use connections field.
connections List<BackupRecoverySourceRegistrationConnection>
Specfies the list of connections for the source. Nested schema for connections:
connectorGroupId Double
Specifies the connector group id of connector groups.
dataSourceConnectionId String
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. Also, this is the 'string' of connectionId. This property was added to accommodate for ID values that exceed 2^53 - 1, which is the max value for which JS maintains precision.
encryptionKey String
Specifies the key that user has encrypted the credential with.
isInternalEncrypted Boolean
Specifies if credentials are encrypted by internal key.
name String
The user specified name for this source.
physicalParams BackupRecoverySourceRegistrationPhysicalParams
Specifies parameters to register physical server. Nested schema for physical_params:
environment This property is required. string
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
xIbmTenantId This property is required. string
Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
advancedConfigs BackupRecoverySourceRegistrationAdvancedConfig[]
Specifies the advanced configuration for a protection source. Nested schema for advanced_configs:
backupRecoverySourceRegistrationId string
(String) The tenant id.
connectionId string
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. This field will be depricated in future. Use connections field.
connections BackupRecoverySourceRegistrationConnection[]
Specfies the list of connections for the source. Nested schema for connections:
connectorGroupId number
Specifies the connector group id of connector groups.
dataSourceConnectionId string
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. Also, this is the 'string' of connectionId. This property was added to accommodate for ID values that exceed 2^53 - 1, which is the max value for which JS maintains precision.
encryptionKey string
Specifies the key that user has encrypted the credential with.
isInternalEncrypted boolean
Specifies if credentials are encrypted by internal key.
name string
The user specified name for this source.
physicalParams BackupRecoverySourceRegistrationPhysicalParams
Specifies parameters to register physical server. Nested schema for physical_params:
environment This property is required. str
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
x_ibm_tenant_id This property is required. str
Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
advanced_configs Sequence[BackupRecoverySourceRegistrationAdvancedConfigArgs]
Specifies the advanced configuration for a protection source. Nested schema for advanced_configs:
backup_recovery_source_registration_id str
(String) The tenant id.
connection_id str
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. This field will be depricated in future. Use connections field.
connections Sequence[BackupRecoverySourceRegistrationConnectionArgs]
Specfies the list of connections for the source. Nested schema for connections:
connector_group_id float
Specifies the connector group id of connector groups.
data_source_connection_id str
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. Also, this is the 'string' of connectionId. This property was added to accommodate for ID values that exceed 2^53 - 1, which is the max value for which JS maintains precision.
encryption_key str
Specifies the key that user has encrypted the credential with.
is_internal_encrypted bool
Specifies if credentials are encrypted by internal key.
name str
The user specified name for this source.
physical_params BackupRecoverySourceRegistrationPhysicalParamsArgs
Specifies parameters to register physical server. Nested schema for physical_params:
environment This property is required. String
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
xIbmTenantId This property is required. String
Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
advancedConfigs List<Property Map>
Specifies the advanced configuration for a protection source. Nested schema for advanced_configs:
backupRecoverySourceRegistrationId String
(String) The tenant id.
connectionId String
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. This field will be depricated in future. Use connections field.
connections List<Property Map>
Specfies the list of connections for the source. Nested schema for connections:
connectorGroupId Number
Specifies the connector group id of connector groups.
dataSourceConnectionId String
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. Also, this is the 'string' of connectionId. This property was added to accommodate for ID values that exceed 2^53 - 1, which is the max value for which JS maintains precision.
encryptionKey String
Specifies the key that user has encrypted the credential with.
isInternalEncrypted Boolean
Specifies if credentials are encrypted by internal key.
name String
The user specified name for this source.
physicalParams Property Map
Specifies parameters to register physical server. Nested schema for physical_params:

Outputs

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

AuthenticationStatus string
(String) Specifies the status of the authentication during the registration of a Protection Source. 'Pending' indicates the authentication is in progress. 'Scheduled' indicates the authentication is scheduled. 'Finished' indicates the authentication is completed. 'RefreshInProgress' indicates the refresh is in progress.

  • Constraints: Allowable values are: Pending, Scheduled, Finished, RefreshInProgress.
ExternalMetadatas List<BackupRecoverySourceRegistrationExternalMetadata>
(List) Specifies the External metadata of an entity. Nested schema for external_metadata:
Id string
The provider-assigned unique ID for this managed resource.
LastRefreshedTimeMsecs double
(Integer) Specifies the time when the source was last refreshed in milliseconds.
RegistrationTimeMsecs double
(Integer) Specifies the time when the source was registered in milliseconds.
SourceId double
(Integer) Specifies registered source id to which object belongs.
SourceInfos List<BackupRecoverySourceRegistrationSourceInfo>
(List) Specifies information about an object. Nested schema for source_info:
AuthenticationStatus string
(String) Specifies the status of the authentication during the registration of a Protection Source. 'Pending' indicates the authentication is in progress. 'Scheduled' indicates the authentication is scheduled. 'Finished' indicates the authentication is completed. 'RefreshInProgress' indicates the refresh is in progress.

  • Constraints: Allowable values are: Pending, Scheduled, Finished, RefreshInProgress.
ExternalMetadatas []BackupRecoverySourceRegistrationExternalMetadata
(List) Specifies the External metadata of an entity. Nested schema for external_metadata:
Id string
The provider-assigned unique ID for this managed resource.
LastRefreshedTimeMsecs float64
(Integer) Specifies the time when the source was last refreshed in milliseconds.
RegistrationTimeMsecs float64
(Integer) Specifies the time when the source was registered in milliseconds.
SourceId float64
(Integer) Specifies registered source id to which object belongs.
SourceInfos []BackupRecoverySourceRegistrationSourceInfo
(List) Specifies information about an object. Nested schema for source_info:
authenticationStatus String
(String) Specifies the status of the authentication during the registration of a Protection Source. 'Pending' indicates the authentication is in progress. 'Scheduled' indicates the authentication is scheduled. 'Finished' indicates the authentication is completed. 'RefreshInProgress' indicates the refresh is in progress.

  • Constraints: Allowable values are: Pending, Scheduled, Finished, RefreshInProgress.
externalMetadatas List<BackupRecoverySourceRegistrationExternalMetadata>
(List) Specifies the External metadata of an entity. Nested schema for external_metadata:
id String
The provider-assigned unique ID for this managed resource.
lastRefreshedTimeMsecs Double
(Integer) Specifies the time when the source was last refreshed in milliseconds.
registrationTimeMsecs Double
(Integer) Specifies the time when the source was registered in milliseconds.
sourceId Double
(Integer) Specifies registered source id to which object belongs.
sourceInfos List<BackupRecoverySourceRegistrationSourceInfo>
(List) Specifies information about an object. Nested schema for source_info:
authenticationStatus string
(String) Specifies the status of the authentication during the registration of a Protection Source. 'Pending' indicates the authentication is in progress. 'Scheduled' indicates the authentication is scheduled. 'Finished' indicates the authentication is completed. 'RefreshInProgress' indicates the refresh is in progress.

  • Constraints: Allowable values are: Pending, Scheduled, Finished, RefreshInProgress.
externalMetadatas BackupRecoverySourceRegistrationExternalMetadata[]
(List) Specifies the External metadata of an entity. Nested schema for external_metadata:
id string
The provider-assigned unique ID for this managed resource.
lastRefreshedTimeMsecs number
(Integer) Specifies the time when the source was last refreshed in milliseconds.
registrationTimeMsecs number
(Integer) Specifies the time when the source was registered in milliseconds.
sourceId number
(Integer) Specifies registered source id to which object belongs.
sourceInfos BackupRecoverySourceRegistrationSourceInfo[]
(List) Specifies information about an object. Nested schema for source_info:
authentication_status str
(String) Specifies the status of the authentication during the registration of a Protection Source. 'Pending' indicates the authentication is in progress. 'Scheduled' indicates the authentication is scheduled. 'Finished' indicates the authentication is completed. 'RefreshInProgress' indicates the refresh is in progress.

  • Constraints: Allowable values are: Pending, Scheduled, Finished, RefreshInProgress.
external_metadatas Sequence[BackupRecoverySourceRegistrationExternalMetadata]
(List) Specifies the External metadata of an entity. Nested schema for external_metadata:
id str
The provider-assigned unique ID for this managed resource.
last_refreshed_time_msecs float
(Integer) Specifies the time when the source was last refreshed in milliseconds.
registration_time_msecs float
(Integer) Specifies the time when the source was registered in milliseconds.
source_id float
(Integer) Specifies registered source id to which object belongs.
source_infos Sequence[BackupRecoverySourceRegistrationSourceInfo]
(List) Specifies information about an object. Nested schema for source_info:
authenticationStatus String
(String) Specifies the status of the authentication during the registration of a Protection Source. 'Pending' indicates the authentication is in progress. 'Scheduled' indicates the authentication is scheduled. 'Finished' indicates the authentication is completed. 'RefreshInProgress' indicates the refresh is in progress.

  • Constraints: Allowable values are: Pending, Scheduled, Finished, RefreshInProgress.
externalMetadatas List<Property Map>
(List) Specifies the External metadata of an entity. Nested schema for external_metadata:
id String
The provider-assigned unique ID for this managed resource.
lastRefreshedTimeMsecs Number
(Integer) Specifies the time when the source was last refreshed in milliseconds.
registrationTimeMsecs Number
(Integer) Specifies the time when the source was registered in milliseconds.
sourceId Number
(Integer) Specifies registered source id to which object belongs.
sourceInfos List<Property Map>
(List) Specifies information about an object. Nested schema for source_info:

Look up Existing BackupRecoverySourceRegistration Resource

Get an existing BackupRecoverySourceRegistration 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?: BackupRecoverySourceRegistrationState, opts?: CustomResourceOptions): BackupRecoverySourceRegistration
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        advanced_configs: Optional[Sequence[BackupRecoverySourceRegistrationAdvancedConfigArgs]] = None,
        authentication_status: Optional[str] = None,
        backup_recovery_source_registration_id: Optional[str] = None,
        connection_id: Optional[str] = None,
        connections: Optional[Sequence[BackupRecoverySourceRegistrationConnectionArgs]] = None,
        connector_group_id: Optional[float] = None,
        data_source_connection_id: Optional[str] = None,
        encryption_key: Optional[str] = None,
        environment: Optional[str] = None,
        external_metadatas: Optional[Sequence[BackupRecoverySourceRegistrationExternalMetadataArgs]] = None,
        is_internal_encrypted: Optional[bool] = None,
        last_refreshed_time_msecs: Optional[float] = None,
        name: Optional[str] = None,
        physical_params: Optional[BackupRecoverySourceRegistrationPhysicalParamsArgs] = None,
        registration_time_msecs: Optional[float] = None,
        source_id: Optional[float] = None,
        source_infos: Optional[Sequence[BackupRecoverySourceRegistrationSourceInfoArgs]] = None,
        x_ibm_tenant_id: Optional[str] = None) -> BackupRecoverySourceRegistration
func GetBackupRecoverySourceRegistration(ctx *Context, name string, id IDInput, state *BackupRecoverySourceRegistrationState, opts ...ResourceOption) (*BackupRecoverySourceRegistration, error)
public static BackupRecoverySourceRegistration Get(string name, Input<string> id, BackupRecoverySourceRegistrationState? state, CustomResourceOptions? opts = null)
public static BackupRecoverySourceRegistration get(String name, Output<String> id, BackupRecoverySourceRegistrationState state, CustomResourceOptions options)
resources:  _:    type: ibm:BackupRecoverySourceRegistration    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AdvancedConfigs List<BackupRecoverySourceRegistrationAdvancedConfig>
Specifies the advanced configuration for a protection source. Nested schema for advanced_configs:
AuthenticationStatus string
(String) Specifies the status of the authentication during the registration of a Protection Source. 'Pending' indicates the authentication is in progress. 'Scheduled' indicates the authentication is scheduled. 'Finished' indicates the authentication is completed. 'RefreshInProgress' indicates the refresh is in progress.

  • Constraints: Allowable values are: Pending, Scheduled, Finished, RefreshInProgress.
BackupRecoverySourceRegistrationId string
(String) The tenant id.
ConnectionId string
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. This field will be depricated in future. Use connections field.
Connections List<BackupRecoverySourceRegistrationConnection>
Specfies the list of connections for the source. Nested schema for connections:
ConnectorGroupId double
Specifies the connector group id of connector groups.
DataSourceConnectionId string
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. Also, this is the 'string' of connectionId. This property was added to accommodate for ID values that exceed 2^53 - 1, which is the max value for which JS maintains precision.
EncryptionKey string
Specifies the key that user has encrypted the credential with.
Environment string
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
ExternalMetadatas List<BackupRecoverySourceRegistrationExternalMetadata>
(List) Specifies the External metadata of an entity. Nested schema for external_metadata:
IsInternalEncrypted bool
Specifies if credentials are encrypted by internal key.
LastRefreshedTimeMsecs double
(Integer) Specifies the time when the source was last refreshed in milliseconds.
Name string
The user specified name for this source.
PhysicalParams BackupRecoverySourceRegistrationPhysicalParams
Specifies parameters to register physical server. Nested schema for physical_params:
RegistrationTimeMsecs double
(Integer) Specifies the time when the source was registered in milliseconds.
SourceId double
(Integer) Specifies registered source id to which object belongs.
SourceInfos List<BackupRecoverySourceRegistrationSourceInfo>
(List) Specifies information about an object. Nested schema for source_info:
XIbmTenantId string
Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
AdvancedConfigs []BackupRecoverySourceRegistrationAdvancedConfigArgs
Specifies the advanced configuration for a protection source. Nested schema for advanced_configs:
AuthenticationStatus string
(String) Specifies the status of the authentication during the registration of a Protection Source. 'Pending' indicates the authentication is in progress. 'Scheduled' indicates the authentication is scheduled. 'Finished' indicates the authentication is completed. 'RefreshInProgress' indicates the refresh is in progress.

  • Constraints: Allowable values are: Pending, Scheduled, Finished, RefreshInProgress.
BackupRecoverySourceRegistrationId string
(String) The tenant id.
ConnectionId string
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. This field will be depricated in future. Use connections field.
Connections []BackupRecoverySourceRegistrationConnectionArgs
Specfies the list of connections for the source. Nested schema for connections:
ConnectorGroupId float64
Specifies the connector group id of connector groups.
DataSourceConnectionId string
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. Also, this is the 'string' of connectionId. This property was added to accommodate for ID values that exceed 2^53 - 1, which is the max value for which JS maintains precision.
EncryptionKey string
Specifies the key that user has encrypted the credential with.
Environment string
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
ExternalMetadatas []BackupRecoverySourceRegistrationExternalMetadataArgs
(List) Specifies the External metadata of an entity. Nested schema for external_metadata:
IsInternalEncrypted bool
Specifies if credentials are encrypted by internal key.
LastRefreshedTimeMsecs float64
(Integer) Specifies the time when the source was last refreshed in milliseconds.
Name string
The user specified name for this source.
PhysicalParams BackupRecoverySourceRegistrationPhysicalParamsArgs
Specifies parameters to register physical server. Nested schema for physical_params:
RegistrationTimeMsecs float64
(Integer) Specifies the time when the source was registered in milliseconds.
SourceId float64
(Integer) Specifies registered source id to which object belongs.
SourceInfos []BackupRecoverySourceRegistrationSourceInfoArgs
(List) Specifies information about an object. Nested schema for source_info:
XIbmTenantId string
Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
advancedConfigs List<BackupRecoverySourceRegistrationAdvancedConfig>
Specifies the advanced configuration for a protection source. Nested schema for advanced_configs:
authenticationStatus String
(String) Specifies the status of the authentication during the registration of a Protection Source. 'Pending' indicates the authentication is in progress. 'Scheduled' indicates the authentication is scheduled. 'Finished' indicates the authentication is completed. 'RefreshInProgress' indicates the refresh is in progress.

  • Constraints: Allowable values are: Pending, Scheduled, Finished, RefreshInProgress.
backupRecoverySourceRegistrationId String
(String) The tenant id.
connectionId String
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. This field will be depricated in future. Use connections field.
connections List<BackupRecoverySourceRegistrationConnection>
Specfies the list of connections for the source. Nested schema for connections:
connectorGroupId Double
Specifies the connector group id of connector groups.
dataSourceConnectionId String
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. Also, this is the 'string' of connectionId. This property was added to accommodate for ID values that exceed 2^53 - 1, which is the max value for which JS maintains precision.
encryptionKey String
Specifies the key that user has encrypted the credential with.
environment String
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
externalMetadatas List<BackupRecoverySourceRegistrationExternalMetadata>
(List) Specifies the External metadata of an entity. Nested schema for external_metadata:
isInternalEncrypted Boolean
Specifies if credentials are encrypted by internal key.
lastRefreshedTimeMsecs Double
(Integer) Specifies the time when the source was last refreshed in milliseconds.
name String
The user specified name for this source.
physicalParams BackupRecoverySourceRegistrationPhysicalParams
Specifies parameters to register physical server. Nested schema for physical_params:
registrationTimeMsecs Double
(Integer) Specifies the time when the source was registered in milliseconds.
sourceId Double
(Integer) Specifies registered source id to which object belongs.
sourceInfos List<BackupRecoverySourceRegistrationSourceInfo>
(List) Specifies information about an object. Nested schema for source_info:
xIbmTenantId String
Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
advancedConfigs BackupRecoverySourceRegistrationAdvancedConfig[]
Specifies the advanced configuration for a protection source. Nested schema for advanced_configs:
authenticationStatus string
(String) Specifies the status of the authentication during the registration of a Protection Source. 'Pending' indicates the authentication is in progress. 'Scheduled' indicates the authentication is scheduled. 'Finished' indicates the authentication is completed. 'RefreshInProgress' indicates the refresh is in progress.

  • Constraints: Allowable values are: Pending, Scheduled, Finished, RefreshInProgress.
backupRecoverySourceRegistrationId string
(String) The tenant id.
connectionId string
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. This field will be depricated in future. Use connections field.
connections BackupRecoverySourceRegistrationConnection[]
Specfies the list of connections for the source. Nested schema for connections:
connectorGroupId number
Specifies the connector group id of connector groups.
dataSourceConnectionId string
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. Also, this is the 'string' of connectionId. This property was added to accommodate for ID values that exceed 2^53 - 1, which is the max value for which JS maintains precision.
encryptionKey string
Specifies the key that user has encrypted the credential with.
environment string
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
externalMetadatas BackupRecoverySourceRegistrationExternalMetadata[]
(List) Specifies the External metadata of an entity. Nested schema for external_metadata:
isInternalEncrypted boolean
Specifies if credentials are encrypted by internal key.
lastRefreshedTimeMsecs number
(Integer) Specifies the time when the source was last refreshed in milliseconds.
name string
The user specified name for this source.
physicalParams BackupRecoverySourceRegistrationPhysicalParams
Specifies parameters to register physical server. Nested schema for physical_params:
registrationTimeMsecs number
(Integer) Specifies the time when the source was registered in milliseconds.
sourceId number
(Integer) Specifies registered source id to which object belongs.
sourceInfos BackupRecoverySourceRegistrationSourceInfo[]
(List) Specifies information about an object. Nested schema for source_info:
xIbmTenantId string
Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
advanced_configs Sequence[BackupRecoverySourceRegistrationAdvancedConfigArgs]
Specifies the advanced configuration for a protection source. Nested schema for advanced_configs:
authentication_status str
(String) Specifies the status of the authentication during the registration of a Protection Source. 'Pending' indicates the authentication is in progress. 'Scheduled' indicates the authentication is scheduled. 'Finished' indicates the authentication is completed. 'RefreshInProgress' indicates the refresh is in progress.

  • Constraints: Allowable values are: Pending, Scheduled, Finished, RefreshInProgress.
backup_recovery_source_registration_id str
(String) The tenant id.
connection_id str
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. This field will be depricated in future. Use connections field.
connections Sequence[BackupRecoverySourceRegistrationConnectionArgs]
Specfies the list of connections for the source. Nested schema for connections:
connector_group_id float
Specifies the connector group id of connector groups.
data_source_connection_id str
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. Also, this is the 'string' of connectionId. This property was added to accommodate for ID values that exceed 2^53 - 1, which is the max value for which JS maintains precision.
encryption_key str
Specifies the key that user has encrypted the credential with.
environment str
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
external_metadatas Sequence[BackupRecoverySourceRegistrationExternalMetadataArgs]
(List) Specifies the External metadata of an entity. Nested schema for external_metadata:
is_internal_encrypted bool
Specifies if credentials are encrypted by internal key.
last_refreshed_time_msecs float
(Integer) Specifies the time when the source was last refreshed in milliseconds.
name str
The user specified name for this source.
physical_params BackupRecoverySourceRegistrationPhysicalParamsArgs
Specifies parameters to register physical server. Nested schema for physical_params:
registration_time_msecs float
(Integer) Specifies the time when the source was registered in milliseconds.
source_id float
(Integer) Specifies registered source id to which object belongs.
source_infos Sequence[BackupRecoverySourceRegistrationSourceInfoArgs]
(List) Specifies information about an object. Nested schema for source_info:
x_ibm_tenant_id str
Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
advancedConfigs List<Property Map>
Specifies the advanced configuration for a protection source. Nested schema for advanced_configs:
authenticationStatus String
(String) Specifies the status of the authentication during the registration of a Protection Source. 'Pending' indicates the authentication is in progress. 'Scheduled' indicates the authentication is scheduled. 'Finished' indicates the authentication is completed. 'RefreshInProgress' indicates the refresh is in progress.

  • Constraints: Allowable values are: Pending, Scheduled, Finished, RefreshInProgress.
backupRecoverySourceRegistrationId String
(String) The tenant id.
connectionId String
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. This field will be depricated in future. Use connections field.
connections List<Property Map>
Specfies the list of connections for the source. Nested schema for connections:
connectorGroupId Number
Specifies the connector group id of connector groups.
dataSourceConnectionId String
Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. Also, this is the 'string' of connectionId. This property was added to accommodate for ID values that exceed 2^53 - 1, which is the max value for which JS maintains precision.
encryptionKey String
Specifies the key that user has encrypted the credential with.
environment String
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
externalMetadatas List<Property Map>
(List) Specifies the External metadata of an entity. Nested schema for external_metadata:
isInternalEncrypted Boolean
Specifies if credentials are encrypted by internal key.
lastRefreshedTimeMsecs Number
(Integer) Specifies the time when the source was last refreshed in milliseconds.
name String
The user specified name for this source.
physicalParams Property Map
Specifies parameters to register physical server. Nested schema for physical_params:
registrationTimeMsecs Number
(Integer) Specifies the time when the source was registered in milliseconds.
sourceId Number
(Integer) Specifies registered source id to which object belongs.
sourceInfos List<Property Map>
(List) Specifies information about an object. Nested schema for source_info:
xIbmTenantId String
Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.

Supporting Types

BackupRecoverySourceRegistrationAdvancedConfig
, BackupRecoverySourceRegistrationAdvancedConfigArgs

Key This property is required. string
key.
Value This property is required. string
value.
Key This property is required. string
key.
Value This property is required. string
value.
key This property is required. String
key.
value This property is required. String
value.
key This property is required. string
key.
value This property is required. string
value.
key This property is required. str
key.
value This property is required. str
value.
key This property is required. String
key.
value This property is required. String
value.

BackupRecoverySourceRegistrationConnection
, BackupRecoverySourceRegistrationConnectionArgs

ConnectionId string
Specifies the id of the connection.
ConnectorGroupId double
Specifies the connector group id of connector groups.
DataSourceConnectionId string
Specifies the id of the connection in string format.
EntityId double
Specifies the entity id of the source. The source can a non-root entity.
ConnectionId string
Specifies the id of the connection.
ConnectorGroupId float64
Specifies the connector group id of connector groups.
DataSourceConnectionId string
Specifies the id of the connection in string format.
EntityId float64
Specifies the entity id of the source. The source can a non-root entity.
connectionId String
Specifies the id of the connection.
connectorGroupId Double
Specifies the connector group id of connector groups.
dataSourceConnectionId String
Specifies the id of the connection in string format.
entityId Double
Specifies the entity id of the source. The source can a non-root entity.
connectionId string
Specifies the id of the connection.
connectorGroupId number
Specifies the connector group id of connector groups.
dataSourceConnectionId string
Specifies the id of the connection in string format.
entityId number
Specifies the entity id of the source. The source can a non-root entity.
connection_id str
Specifies the id of the connection.
connector_group_id float
Specifies the connector group id of connector groups.
data_source_connection_id str
Specifies the id of the connection in string format.
entity_id float
Specifies the entity id of the source. The source can a non-root entity.
connectionId String
Specifies the id of the connection.
connectorGroupId Number
Specifies the connector group id of connector groups.
dataSourceConnectionId String
Specifies the id of the connection in string format.
entityId Number
Specifies the entity id of the source. The source can a non-root entity.

BackupRecoverySourceRegistrationExternalMetadata
, BackupRecoverySourceRegistrationExternalMetadataArgs

MaintenanceModeConfigs This property is required. List<BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfig>
(List) Specifies the entity metadata for maintenance mode. Nested schema for maintenance_mode_config:
MaintenanceModeConfigs This property is required. []BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfig
(List) Specifies the entity metadata for maintenance mode. Nested schema for maintenance_mode_config:
maintenanceModeConfigs This property is required. List<BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfig>
(List) Specifies the entity metadata for maintenance mode. Nested schema for maintenance_mode_config:
maintenanceModeConfigs This property is required. BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfig[]
(List) Specifies the entity metadata for maintenance mode. Nested schema for maintenance_mode_config:
maintenance_mode_configs This property is required. Sequence[BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfig]
(List) Specifies the entity metadata for maintenance mode. Nested schema for maintenance_mode_config:
maintenanceModeConfigs This property is required. List<Property Map>
(List) Specifies the entity metadata for maintenance mode. Nested schema for maintenance_mode_config:

BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfig
, BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigArgs

ActivationTimeIntervals This property is required. List<BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigActivationTimeInterval>
(List) Specifies the absolute intervals where the maintenance schedule is valid, i.e. maintenance_shedule is considered only for these time ranges. (For example, if there is one time range with [now_usecs, now_usecs + 10 days], the action will be done during the maintenance_schedule for the next 10 days.)The start time must be specified. The end time can be -1 which would denote an indefinite maintenance mode. Nested schema for activation_time_intervals:
MaintenanceSchedules This property is required. List<BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedule>
(List) Specifies a schedule for actions to be taken. Nested schema for maintenance_schedule:
UserMessage This property is required. string
(String) User provided message associated with this maintenance mode.
WorkflowInterventionSpecLists This property is required. List<BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigWorkflowInterventionSpecList>
(List) Specifies the type of intervention for different workflows when the source goes into maintenance mode. Nested schema for workflow_intervention_spec_list:
ActivationTimeIntervals This property is required. []BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigActivationTimeInterval
(List) Specifies the absolute intervals where the maintenance schedule is valid, i.e. maintenance_shedule is considered only for these time ranges. (For example, if there is one time range with [now_usecs, now_usecs + 10 days], the action will be done during the maintenance_schedule for the next 10 days.)The start time must be specified. The end time can be -1 which would denote an indefinite maintenance mode. Nested schema for activation_time_intervals:
MaintenanceSchedules This property is required. []BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedule
(List) Specifies a schedule for actions to be taken. Nested schema for maintenance_schedule:
UserMessage This property is required. string
(String) User provided message associated with this maintenance mode.
WorkflowInterventionSpecLists This property is required. []BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigWorkflowInterventionSpecList
(List) Specifies the type of intervention for different workflows when the source goes into maintenance mode. Nested schema for workflow_intervention_spec_list:
activationTimeIntervals This property is required. List<BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigActivationTimeInterval>
(List) Specifies the absolute intervals where the maintenance schedule is valid, i.e. maintenance_shedule is considered only for these time ranges. (For example, if there is one time range with [now_usecs, now_usecs + 10 days], the action will be done during the maintenance_schedule for the next 10 days.)The start time must be specified. The end time can be -1 which would denote an indefinite maintenance mode. Nested schema for activation_time_intervals:
maintenanceSchedules This property is required. List<BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedule>
(List) Specifies a schedule for actions to be taken. Nested schema for maintenance_schedule:
userMessage This property is required. String
(String) User provided message associated with this maintenance mode.
workflowInterventionSpecLists This property is required. List<BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigWorkflowInterventionSpecList>
(List) Specifies the type of intervention for different workflows when the source goes into maintenance mode. Nested schema for workflow_intervention_spec_list:
activationTimeIntervals This property is required. BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigActivationTimeInterval[]
(List) Specifies the absolute intervals where the maintenance schedule is valid, i.e. maintenance_shedule is considered only for these time ranges. (For example, if there is one time range with [now_usecs, now_usecs + 10 days], the action will be done during the maintenance_schedule for the next 10 days.)The start time must be specified. The end time can be -1 which would denote an indefinite maintenance mode. Nested schema for activation_time_intervals:
maintenanceSchedules This property is required. BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedule[]
(List) Specifies a schedule for actions to be taken. Nested schema for maintenance_schedule:
userMessage This property is required. string
(String) User provided message associated with this maintenance mode.
workflowInterventionSpecLists This property is required. BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigWorkflowInterventionSpecList[]
(List) Specifies the type of intervention for different workflows when the source goes into maintenance mode. Nested schema for workflow_intervention_spec_list:
activation_time_intervals This property is required. Sequence[BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigActivationTimeInterval]
(List) Specifies the absolute intervals where the maintenance schedule is valid, i.e. maintenance_shedule is considered only for these time ranges. (For example, if there is one time range with [now_usecs, now_usecs + 10 days], the action will be done during the maintenance_schedule for the next 10 days.)The start time must be specified. The end time can be -1 which would denote an indefinite maintenance mode. Nested schema for activation_time_intervals:
maintenance_schedules This property is required. Sequence[BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedule]
(List) Specifies a schedule for actions to be taken. Nested schema for maintenance_schedule:
user_message This property is required. str
(String) User provided message associated with this maintenance mode.
workflow_intervention_spec_lists This property is required. Sequence[BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigWorkflowInterventionSpecList]
(List) Specifies the type of intervention for different workflows when the source goes into maintenance mode. Nested schema for workflow_intervention_spec_list:
activationTimeIntervals This property is required. List<Property Map>
(List) Specifies the absolute intervals where the maintenance schedule is valid, i.e. maintenance_shedule is considered only for these time ranges. (For example, if there is one time range with [now_usecs, now_usecs + 10 days], the action will be done during the maintenance_schedule for the next 10 days.)The start time must be specified. The end time can be -1 which would denote an indefinite maintenance mode. Nested schema for activation_time_intervals:
maintenanceSchedules This property is required. List<Property Map>
(List) Specifies a schedule for actions to be taken. Nested schema for maintenance_schedule:
userMessage This property is required. String
(String) User provided message associated with this maintenance mode.
workflowInterventionSpecLists This property is required. List<Property Map>
(List) Specifies the type of intervention for different workflows when the source goes into maintenance mode. Nested schema for workflow_intervention_spec_list:

BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigActivationTimeInterval
, BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigActivationTimeIntervalArgs

EndTimeUsecs This property is required. double
(Integer) Specifies the end time of this time range.
StartTimeUsecs This property is required. double
(Integer) Specifies the start time of this time range.
EndTimeUsecs This property is required. float64
(Integer) Specifies the end time of this time range.
StartTimeUsecs This property is required. float64
(Integer) Specifies the start time of this time range.
endTimeUsecs This property is required. Double
(Integer) Specifies the end time of this time range.
startTimeUsecs This property is required. Double
(Integer) Specifies the start time of this time range.
endTimeUsecs This property is required. number
(Integer) Specifies the end time of this time range.
startTimeUsecs This property is required. number
(Integer) Specifies the start time of this time range.
end_time_usecs This property is required. float
(Integer) Specifies the end time of this time range.
start_time_usecs This property is required. float
(Integer) Specifies the start time of this time range.
endTimeUsecs This property is required. Number
(Integer) Specifies the end time of this time range.
startTimeUsecs This property is required. Number
(Integer) Specifies the start time of this time range.

BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedule
, BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceScheduleArgs

PeriodicTimeWindows This property is required. List<BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindow>
(List) Specifies the time range within the days of the week. Nested schema for periodic_time_windows:
ScheduleType This property is required. string
(String) Specifies the type of schedule for this ScheduleProto.

  • Constraints: Allowable values are: PeriodicTimeWindows, CustomIntervals.
TimeRanges This property is required. List<BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceScheduleTimeRange>
(List) Specifies the time ranges in usecs. Nested schema for time_ranges:
Timezone This property is required. string
(String) Specifies the timezone of the user of this ScheduleProto. The timezones have unique names of the form 'Area/Location'.
PeriodicTimeWindows This property is required. []BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindow
(List) Specifies the time range within the days of the week. Nested schema for periodic_time_windows:
ScheduleType This property is required. string
(String) Specifies the type of schedule for this ScheduleProto.

  • Constraints: Allowable values are: PeriodicTimeWindows, CustomIntervals.
TimeRanges This property is required. []BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceScheduleTimeRange
(List) Specifies the time ranges in usecs. Nested schema for time_ranges:
Timezone This property is required. string
(String) Specifies the timezone of the user of this ScheduleProto. The timezones have unique names of the form 'Area/Location'.
periodicTimeWindows This property is required. List<BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindow>
(List) Specifies the time range within the days of the week. Nested schema for periodic_time_windows:
scheduleType This property is required. String
(String) Specifies the type of schedule for this ScheduleProto.

  • Constraints: Allowable values are: PeriodicTimeWindows, CustomIntervals.
timeRanges This property is required. List<BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceScheduleTimeRange>
(List) Specifies the time ranges in usecs. Nested schema for time_ranges:
timezone This property is required. String
(String) Specifies the timezone of the user of this ScheduleProto. The timezones have unique names of the form 'Area/Location'.
periodicTimeWindows This property is required. BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindow[]
(List) Specifies the time range within the days of the week. Nested schema for periodic_time_windows:
scheduleType This property is required. string
(String) Specifies the type of schedule for this ScheduleProto.

  • Constraints: Allowable values are: PeriodicTimeWindows, CustomIntervals.
timeRanges This property is required. BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceScheduleTimeRange[]
(List) Specifies the time ranges in usecs. Nested schema for time_ranges:
timezone This property is required. string
(String) Specifies the timezone of the user of this ScheduleProto. The timezones have unique names of the form 'Area/Location'.
periodic_time_windows This property is required. Sequence[BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindow]
(List) Specifies the time range within the days of the week. Nested schema for periodic_time_windows:
schedule_type This property is required. str
(String) Specifies the type of schedule for this ScheduleProto.

  • Constraints: Allowable values are: PeriodicTimeWindows, CustomIntervals.
time_ranges This property is required. Sequence[BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceScheduleTimeRange]
(List) Specifies the time ranges in usecs. Nested schema for time_ranges:
timezone This property is required. str
(String) Specifies the timezone of the user of this ScheduleProto. The timezones have unique names of the form 'Area/Location'.
periodicTimeWindows This property is required. List<Property Map>
(List) Specifies the time range within the days of the week. Nested schema for periodic_time_windows:
scheduleType This property is required. String
(String) Specifies the type of schedule for this ScheduleProto.

  • Constraints: Allowable values are: PeriodicTimeWindows, CustomIntervals.
timeRanges This property is required. List<Property Map>
(List) Specifies the time ranges in usecs. Nested schema for time_ranges:
timezone This property is required. String
(String) Specifies the timezone of the user of this ScheduleProto. The timezones have unique names of the form 'Area/Location'.

BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindow
, BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindowArgs

DayOfTheWeek This property is required. string
(String) Specifies the week day.

  • Constraints: Allowable values are: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.
EndTimes This property is required. List<BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindowEndTime>
(List) Specifies the time in hours and minutes. Nested schema for end_time:
StartTimes This property is required. List<BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindowStartTime>
(List) Specifies the time in hours and minutes. Nested schema for start_time:
DayOfTheWeek This property is required. string
(String) Specifies the week day.

  • Constraints: Allowable values are: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.
EndTimes This property is required. []BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindowEndTime
(List) Specifies the time in hours and minutes. Nested schema for end_time:
StartTimes This property is required. []BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindowStartTime
(List) Specifies the time in hours and minutes. Nested schema for start_time:
dayOfTheWeek This property is required. String
(String) Specifies the week day.

  • Constraints: Allowable values are: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.
endTimes This property is required. List<BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindowEndTime>
(List) Specifies the time in hours and minutes. Nested schema for end_time:
startTimes This property is required. List<BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindowStartTime>
(List) Specifies the time in hours and minutes. Nested schema for start_time:
dayOfTheWeek This property is required. string
(String) Specifies the week day.

  • Constraints: Allowable values are: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.
endTimes This property is required. BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindowEndTime[]
(List) Specifies the time in hours and minutes. Nested schema for end_time:
startTimes This property is required. BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindowStartTime[]
(List) Specifies the time in hours and minutes. Nested schema for start_time:
day_of_the_week This property is required. str
(String) Specifies the week day.

  • Constraints: Allowable values are: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.
end_times This property is required. Sequence[BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindowEndTime]
(List) Specifies the time in hours and minutes. Nested schema for end_time:
start_times This property is required. Sequence[BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindowStartTime]
(List) Specifies the time in hours and minutes. Nested schema for start_time:
dayOfTheWeek This property is required. String
(String) Specifies the week day.

  • Constraints: Allowable values are: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.
endTimes This property is required. List<Property Map>
(List) Specifies the time in hours and minutes. Nested schema for end_time:
startTimes This property is required. List<Property Map>
(List) Specifies the time in hours and minutes. Nested schema for start_time:

BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindowEndTime
, BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindowEndTimeArgs

Hour This property is required. double
(Integer) Specifies the hour of this time.
Minute This property is required. double
(Integer) Specifies the minute of this time.
Hour This property is required. float64
(Integer) Specifies the hour of this time.
Minute This property is required. float64
(Integer) Specifies the minute of this time.
hour This property is required. Double
(Integer) Specifies the hour of this time.
minute This property is required. Double
(Integer) Specifies the minute of this time.
hour This property is required. number
(Integer) Specifies the hour of this time.
minute This property is required. number
(Integer) Specifies the minute of this time.
hour This property is required. float
(Integer) Specifies the hour of this time.
minute This property is required. float
(Integer) Specifies the minute of this time.
hour This property is required. Number
(Integer) Specifies the hour of this time.
minute This property is required. Number
(Integer) Specifies the minute of this time.

BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindowStartTime
, BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceSchedulePeriodicTimeWindowStartTimeArgs

Hour This property is required. double
(Integer) Specifies the hour of this time.
Minute This property is required. double
(Integer) Specifies the minute of this time.
Hour This property is required. float64
(Integer) Specifies the hour of this time.
Minute This property is required. float64
(Integer) Specifies the minute of this time.
hour This property is required. Double
(Integer) Specifies the hour of this time.
minute This property is required. Double
(Integer) Specifies the minute of this time.
hour This property is required. number
(Integer) Specifies the hour of this time.
minute This property is required. number
(Integer) Specifies the minute of this time.
hour This property is required. float
(Integer) Specifies the hour of this time.
minute This property is required. float
(Integer) Specifies the minute of this time.
hour This property is required. Number
(Integer) Specifies the hour of this time.
minute This property is required. Number
(Integer) Specifies the minute of this time.

BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceScheduleTimeRange
, BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigMaintenanceScheduleTimeRangeArgs

EndTimeUsecs This property is required. double
(Integer) Specifies the end time of this time range.
StartTimeUsecs This property is required. double
(Integer) Specifies the start time of this time range.
EndTimeUsecs This property is required. float64
(Integer) Specifies the end time of this time range.
StartTimeUsecs This property is required. float64
(Integer) Specifies the start time of this time range.
endTimeUsecs This property is required. Double
(Integer) Specifies the end time of this time range.
startTimeUsecs This property is required. Double
(Integer) Specifies the start time of this time range.
endTimeUsecs This property is required. number
(Integer) Specifies the end time of this time range.
startTimeUsecs This property is required. number
(Integer) Specifies the start time of this time range.
end_time_usecs This property is required. float
(Integer) Specifies the end time of this time range.
start_time_usecs This property is required. float
(Integer) Specifies the start time of this time range.
endTimeUsecs This property is required. Number
(Integer) Specifies the end time of this time range.
startTimeUsecs This property is required. Number
(Integer) Specifies the start time of this time range.

BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigWorkflowInterventionSpecList
, BackupRecoverySourceRegistrationExternalMetadataMaintenanceModeConfigWorkflowInterventionSpecListArgs

Intervention This property is required. string
(String) Specifies the intervention type for ongoing tasks.

  • Constraints: Allowable values are: NoIntervention, Cancel.
WorkflowType This property is required. string
(String) Specifies the workflow type for which an intervention would be needed when maintenance mode begins.

  • Constraints: Allowable values are: BackupRun.
Intervention This property is required. string
(String) Specifies the intervention type for ongoing tasks.

  • Constraints: Allowable values are: NoIntervention, Cancel.
WorkflowType This property is required. string
(String) Specifies the workflow type for which an intervention would be needed when maintenance mode begins.

  • Constraints: Allowable values are: BackupRun.
intervention This property is required. String
(String) Specifies the intervention type for ongoing tasks.

  • Constraints: Allowable values are: NoIntervention, Cancel.
workflowType This property is required. String
(String) Specifies the workflow type for which an intervention would be needed when maintenance mode begins.

  • Constraints: Allowable values are: BackupRun.
intervention This property is required. string
(String) Specifies the intervention type for ongoing tasks.

  • Constraints: Allowable values are: NoIntervention, Cancel.
workflowType This property is required. string
(String) Specifies the workflow type for which an intervention would be needed when maintenance mode begins.

  • Constraints: Allowable values are: BackupRun.
intervention This property is required. str
(String) Specifies the intervention type for ongoing tasks.

  • Constraints: Allowable values are: NoIntervention, Cancel.
workflow_type This property is required. str
(String) Specifies the workflow type for which an intervention would be needed when maintenance mode begins.

  • Constraints: Allowable values are: BackupRun.
intervention This property is required. String
(String) Specifies the intervention type for ongoing tasks.

  • Constraints: Allowable values are: NoIntervention, Cancel.
workflowType This property is required. String
(String) Specifies the workflow type for which an intervention would be needed when maintenance mode begins.

  • Constraints: Allowable values are: BackupRun.

BackupRecoverySourceRegistrationPhysicalParams
, BackupRecoverySourceRegistrationPhysicalParamsArgs

Endpoint This property is required. string
Specifies the endpoint IPaddress, URL or hostname of the physical host.
Applications List<string>
Specifies the list of applications to be registered with Physical Source.

  • Constraints: Allowable list items are: kSQL, kOracle.
ForceRegister bool
The agent running on a physical host will fail the registration if it is already registered as part of another cluster. By setting this option to true, agent can be forced to register with the current cluster.
HostType string
Specifies the type of host.

  • Constraints: Allowable values are: kLinux, kWindows.
PhysicalType string
Specifies the type of physical server.

  • Constraints: Allowable values are: kGroup, kHost, kWindowsCluster, kOracleRACCluster, kOracleAPCluster, kUnixCluster.
Endpoint This property is required. string
Specifies the endpoint IPaddress, URL or hostname of the physical host.
Applications []string
Specifies the list of applications to be registered with Physical Source.

  • Constraints: Allowable list items are: kSQL, kOracle.
ForceRegister bool
The agent running on a physical host will fail the registration if it is already registered as part of another cluster. By setting this option to true, agent can be forced to register with the current cluster.
HostType string
Specifies the type of host.

  • Constraints: Allowable values are: kLinux, kWindows.
PhysicalType string
Specifies the type of physical server.

  • Constraints: Allowable values are: kGroup, kHost, kWindowsCluster, kOracleRACCluster, kOracleAPCluster, kUnixCluster.
endpoint This property is required. String
Specifies the endpoint IPaddress, URL or hostname of the physical host.
applications List<String>
Specifies the list of applications to be registered with Physical Source.

  • Constraints: Allowable list items are: kSQL, kOracle.
forceRegister Boolean
The agent running on a physical host will fail the registration if it is already registered as part of another cluster. By setting this option to true, agent can be forced to register with the current cluster.
hostType String
Specifies the type of host.

  • Constraints: Allowable values are: kLinux, kWindows.
physicalType String
Specifies the type of physical server.

  • Constraints: Allowable values are: kGroup, kHost, kWindowsCluster, kOracleRACCluster, kOracleAPCluster, kUnixCluster.
endpoint This property is required. string
Specifies the endpoint IPaddress, URL or hostname of the physical host.
applications string[]
Specifies the list of applications to be registered with Physical Source.

  • Constraints: Allowable list items are: kSQL, kOracle.
forceRegister boolean
The agent running on a physical host will fail the registration if it is already registered as part of another cluster. By setting this option to true, agent can be forced to register with the current cluster.
hostType string
Specifies the type of host.

  • Constraints: Allowable values are: kLinux, kWindows.
physicalType string
Specifies the type of physical server.

  • Constraints: Allowable values are: kGroup, kHost, kWindowsCluster, kOracleRACCluster, kOracleAPCluster, kUnixCluster.
endpoint This property is required. str
Specifies the endpoint IPaddress, URL or hostname of the physical host.
applications Sequence[str]
Specifies the list of applications to be registered with Physical Source.

  • Constraints: Allowable list items are: kSQL, kOracle.
force_register bool
The agent running on a physical host will fail the registration if it is already registered as part of another cluster. By setting this option to true, agent can be forced to register with the current cluster.
host_type str
Specifies the type of host.

  • Constraints: Allowable values are: kLinux, kWindows.
physical_type str
Specifies the type of physical server.

  • Constraints: Allowable values are: kGroup, kHost, kWindowsCluster, kOracleRACCluster, kOracleAPCluster, kUnixCluster.
endpoint This property is required. String
Specifies the endpoint IPaddress, URL or hostname of the physical host.
applications List<String>
Specifies the list of applications to be registered with Physical Source.

  • Constraints: Allowable list items are: kSQL, kOracle.
forceRegister Boolean
The agent running on a physical host will fail the registration if it is already registered as part of another cluster. By setting this option to true, agent can be forced to register with the current cluster.
hostType String
Specifies the type of host.

  • Constraints: Allowable values are: kLinux, kWindows.
physicalType String
Specifies the type of physical server.

  • Constraints: Allowable values are: kGroup, kHost, kWindowsCluster, kOracleRACCluster, kOracleAPCluster, kUnixCluster.

BackupRecoverySourceRegistrationSourceInfo
, BackupRecoverySourceRegistrationSourceInfoArgs

ChildObjects This property is required. List<BackupRecoverySourceRegistrationSourceInfoChildObject>
(List) Specifies child object details. Nested schema for child_objects:
Environment This property is required. string
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
GlobalId This property is required. string
(String) Specifies the global id which is a unique identifier of the object.
Id This property is required. double
(String) The tenant id.
LogicalSizeBytes This property is required. double
(Integer) Specifies the logical size of object in bytes.
MssqlParams This property is required. List<BackupRecoverySourceRegistrationSourceInfoMssqlParam>
(List) Specifies the parameters for Msssql object. Nested schema for mssql_params:
Name This property is required. string
The user specified name for this source.
ObjectHash This property is required. string
(String) Specifies the hash identifier of the object.
ObjectType This property is required. string
(String) Specifies the type of the object.

  • Constraints: Allowable values are: kCluster, kVserver, kVolume, kVCenter, kStandaloneHost, kvCloudDirector, kFolder, kDatacenter, kComputeResource, kClusterComputeResource, kResourcePool, kDatastore, kHostSystem, kVirtualMachine, kVirtualApp, kStoragePod, kNetwork, kDistributedVirtualPortgroup, kTagCategory, kTag, kOpaqueNetwork, kOrganization, kVirtualDatacenter, kCatalog, kOrgMetadata, kStoragePolicy, kVirtualAppTemplate, kDomain, kOutlook, kMailbox, kUsers, kGroups, kSites, kUser, kGroup, kSite, kApplication, kGraphUser, kPublicFolders, kPublicFolder, kTeams, kTeam, kRootPublicFolder, kO365Exchange, kO365OneDrive, kO365Sharepoint, kKeyspace, kTable, kDatabase, kCollection, kBucket, kNamespace, kSCVMMServer, kStandaloneCluster, kHostGroup, kHypervHost, kHostCluster, kCustomProperty, kTenant, kSubscription, kResourceGroup, kStorageAccount, kStorageKey, kStorageContainer, kStorageBlob, kNetworkSecurityGroup, kVirtualNetwork, kSubnet, kComputeOptions, kSnapshotManagerPermit, kAvailabilitySet, kOVirtManager, kHost, kStorageDomain, kVNicProfile, kIAMUser, kRegion, kAvailabilityZone, kEC2Instance, kVPC, kInstanceType, kKeyPair, kRDSOptionGroup, kRDSParameterGroup, kRDSInstance, kRDSSubnet, kRDSTag, kAuroraTag, kAuroraCluster, kAccount, kSubTaskPermit, kS3Bucket, kS3Tag, kKmsKey, kProject, kLabel, kMetadata, kVPCConnector, kPrismCentral, kOtherHypervisorCluster, kZone, kMountPoint, kStorageArray, kFileSystem, kContainer, kFilesystem, kFileset, kPureProtectionGroup, kVolumeGroup, kStoragePool, kViewBox, kView, kWindowsCluster, kOracleRACCluster, kOracleAPCluster, kService, kPVC, kPersistentVolumeClaim, kPersistentVolume, kRootContainer, kDAGRootContainer, kExchangeNode, kExchangeDAGDatabaseCopy, kExchangeStandaloneDatabase, kExchangeDAG, kExchangeDAGDatabase, kDomainController, kInstance, kAAG, kAAGRootContainer, kAAGDatabase, kRACRootContainer, kTableSpace, kPDB, kObject, kOrg, kAppInstance.
OsType This property is required. string
(String) Specifies the operating system type of the object.

  • Constraints: Allowable values are: kLinux, kWindows.
Permissions This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermission>
(List) Specifies the list of users, groups and users that have permissions for a given object. Nested schema for permissions:
PhysicalParams This property is required. List<BackupRecoverySourceRegistrationSourceInfoPhysicalParam>
Specifies parameters to register physical server. Nested schema for physical_params:
ProtectionStats This property is required. List<BackupRecoverySourceRegistrationSourceInfoProtectionStat>
(List) Specifies the count and size of protected and unprotected objects for the size. Nested schema for protection_stats:
ProtectionType This property is required. string
(String) Specifies the protection type of the object if any.

  • Constraints: Allowable values are: kAgent, kNative, kSnapshotManager, kRDSSnapshotManager, kAuroraSnapshotManager, kAwsS3, kAwsRDSPostgresBackup, kAwsAuroraPostgres, kAwsRDSPostgres, kAzureSQL, kFile, kVolume.
SharepointSiteSummaries This property is required. List<BackupRecoverySourceRegistrationSourceInfoSharepointSiteSummary>
(List) Specifies the common parameters for Sharepoint site objects. Nested schema for sharepoint_site_summary:
SourceId This property is required. double
(Integer) Specifies registered source id to which object belongs.
SourceName This property is required. string
(String) Specifies registered source name to which object belongs.
Uuid This property is required. string
(String) Specifies the uuid which is a unique identifier of the object.
VCenterSummaries This property is required. List<BackupRecoverySourceRegistrationSourceInfoVCenterSummary>
(List) Nested schema for v_center_summary:
WindowsClusterSummaries This property is required. List<BackupRecoverySourceRegistrationSourceInfoWindowsClusterSummary>
(List) Nested schema for windows_cluster_summary:
ChildObjects This property is required. []BackupRecoverySourceRegistrationSourceInfoChildObject
(List) Specifies child object details. Nested schema for child_objects:
Environment This property is required. string
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
GlobalId This property is required. string
(String) Specifies the global id which is a unique identifier of the object.
Id This property is required. float64
(String) The tenant id.
LogicalSizeBytes This property is required. float64
(Integer) Specifies the logical size of object in bytes.
MssqlParams This property is required. []BackupRecoverySourceRegistrationSourceInfoMssqlParam
(List) Specifies the parameters for Msssql object. Nested schema for mssql_params:
Name This property is required. string
The user specified name for this source.
ObjectHash This property is required. string
(String) Specifies the hash identifier of the object.
ObjectType This property is required. string
(String) Specifies the type of the object.

  • Constraints: Allowable values are: kCluster, kVserver, kVolume, kVCenter, kStandaloneHost, kvCloudDirector, kFolder, kDatacenter, kComputeResource, kClusterComputeResource, kResourcePool, kDatastore, kHostSystem, kVirtualMachine, kVirtualApp, kStoragePod, kNetwork, kDistributedVirtualPortgroup, kTagCategory, kTag, kOpaqueNetwork, kOrganization, kVirtualDatacenter, kCatalog, kOrgMetadata, kStoragePolicy, kVirtualAppTemplate, kDomain, kOutlook, kMailbox, kUsers, kGroups, kSites, kUser, kGroup, kSite, kApplication, kGraphUser, kPublicFolders, kPublicFolder, kTeams, kTeam, kRootPublicFolder, kO365Exchange, kO365OneDrive, kO365Sharepoint, kKeyspace, kTable, kDatabase, kCollection, kBucket, kNamespace, kSCVMMServer, kStandaloneCluster, kHostGroup, kHypervHost, kHostCluster, kCustomProperty, kTenant, kSubscription, kResourceGroup, kStorageAccount, kStorageKey, kStorageContainer, kStorageBlob, kNetworkSecurityGroup, kVirtualNetwork, kSubnet, kComputeOptions, kSnapshotManagerPermit, kAvailabilitySet, kOVirtManager, kHost, kStorageDomain, kVNicProfile, kIAMUser, kRegion, kAvailabilityZone, kEC2Instance, kVPC, kInstanceType, kKeyPair, kRDSOptionGroup, kRDSParameterGroup, kRDSInstance, kRDSSubnet, kRDSTag, kAuroraTag, kAuroraCluster, kAccount, kSubTaskPermit, kS3Bucket, kS3Tag, kKmsKey, kProject, kLabel, kMetadata, kVPCConnector, kPrismCentral, kOtherHypervisorCluster, kZone, kMountPoint, kStorageArray, kFileSystem, kContainer, kFilesystem, kFileset, kPureProtectionGroup, kVolumeGroup, kStoragePool, kViewBox, kView, kWindowsCluster, kOracleRACCluster, kOracleAPCluster, kService, kPVC, kPersistentVolumeClaim, kPersistentVolume, kRootContainer, kDAGRootContainer, kExchangeNode, kExchangeDAGDatabaseCopy, kExchangeStandaloneDatabase, kExchangeDAG, kExchangeDAGDatabase, kDomainController, kInstance, kAAG, kAAGRootContainer, kAAGDatabase, kRACRootContainer, kTableSpace, kPDB, kObject, kOrg, kAppInstance.
OsType This property is required. string
(String) Specifies the operating system type of the object.

  • Constraints: Allowable values are: kLinux, kWindows.
Permissions This property is required. []BackupRecoverySourceRegistrationSourceInfoPermission
(List) Specifies the list of users, groups and users that have permissions for a given object. Nested schema for permissions:
PhysicalParams This property is required. []BackupRecoverySourceRegistrationSourceInfoPhysicalParam
Specifies parameters to register physical server. Nested schema for physical_params:
ProtectionStats This property is required. []BackupRecoverySourceRegistrationSourceInfoProtectionStat
(List) Specifies the count and size of protected and unprotected objects for the size. Nested schema for protection_stats:
ProtectionType This property is required. string
(String) Specifies the protection type of the object if any.

  • Constraints: Allowable values are: kAgent, kNative, kSnapshotManager, kRDSSnapshotManager, kAuroraSnapshotManager, kAwsS3, kAwsRDSPostgresBackup, kAwsAuroraPostgres, kAwsRDSPostgres, kAzureSQL, kFile, kVolume.
SharepointSiteSummaries This property is required. []BackupRecoverySourceRegistrationSourceInfoSharepointSiteSummary
(List) Specifies the common parameters for Sharepoint site objects. Nested schema for sharepoint_site_summary:
SourceId This property is required. float64
(Integer) Specifies registered source id to which object belongs.
SourceName This property is required. string
(String) Specifies registered source name to which object belongs.
Uuid This property is required. string
(String) Specifies the uuid which is a unique identifier of the object.
VCenterSummaries This property is required. []BackupRecoverySourceRegistrationSourceInfoVCenterSummary
(List) Nested schema for v_center_summary:
WindowsClusterSummaries This property is required. []BackupRecoverySourceRegistrationSourceInfoWindowsClusterSummary
(List) Nested schema for windows_cluster_summary:
childObjects This property is required. List<BackupRecoverySourceRegistrationSourceInfoChildObject>
(List) Specifies child object details. Nested schema for child_objects:
environment This property is required. String
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
globalId This property is required. String
(String) Specifies the global id which is a unique identifier of the object.
id This property is required. Double
(String) The tenant id.
logicalSizeBytes This property is required. Double
(Integer) Specifies the logical size of object in bytes.
mssqlParams This property is required. List<BackupRecoverySourceRegistrationSourceInfoMssqlParam>
(List) Specifies the parameters for Msssql object. Nested schema for mssql_params:
name This property is required. String
The user specified name for this source.
objectHash This property is required. String
(String) Specifies the hash identifier of the object.
objectType This property is required. String
(String) Specifies the type of the object.

  • Constraints: Allowable values are: kCluster, kVserver, kVolume, kVCenter, kStandaloneHost, kvCloudDirector, kFolder, kDatacenter, kComputeResource, kClusterComputeResource, kResourcePool, kDatastore, kHostSystem, kVirtualMachine, kVirtualApp, kStoragePod, kNetwork, kDistributedVirtualPortgroup, kTagCategory, kTag, kOpaqueNetwork, kOrganization, kVirtualDatacenter, kCatalog, kOrgMetadata, kStoragePolicy, kVirtualAppTemplate, kDomain, kOutlook, kMailbox, kUsers, kGroups, kSites, kUser, kGroup, kSite, kApplication, kGraphUser, kPublicFolders, kPublicFolder, kTeams, kTeam, kRootPublicFolder, kO365Exchange, kO365OneDrive, kO365Sharepoint, kKeyspace, kTable, kDatabase, kCollection, kBucket, kNamespace, kSCVMMServer, kStandaloneCluster, kHostGroup, kHypervHost, kHostCluster, kCustomProperty, kTenant, kSubscription, kResourceGroup, kStorageAccount, kStorageKey, kStorageContainer, kStorageBlob, kNetworkSecurityGroup, kVirtualNetwork, kSubnet, kComputeOptions, kSnapshotManagerPermit, kAvailabilitySet, kOVirtManager, kHost, kStorageDomain, kVNicProfile, kIAMUser, kRegion, kAvailabilityZone, kEC2Instance, kVPC, kInstanceType, kKeyPair, kRDSOptionGroup, kRDSParameterGroup, kRDSInstance, kRDSSubnet, kRDSTag, kAuroraTag, kAuroraCluster, kAccount, kSubTaskPermit, kS3Bucket, kS3Tag, kKmsKey, kProject, kLabel, kMetadata, kVPCConnector, kPrismCentral, kOtherHypervisorCluster, kZone, kMountPoint, kStorageArray, kFileSystem, kContainer, kFilesystem, kFileset, kPureProtectionGroup, kVolumeGroup, kStoragePool, kViewBox, kView, kWindowsCluster, kOracleRACCluster, kOracleAPCluster, kService, kPVC, kPersistentVolumeClaim, kPersistentVolume, kRootContainer, kDAGRootContainer, kExchangeNode, kExchangeDAGDatabaseCopy, kExchangeStandaloneDatabase, kExchangeDAG, kExchangeDAGDatabase, kDomainController, kInstance, kAAG, kAAGRootContainer, kAAGDatabase, kRACRootContainer, kTableSpace, kPDB, kObject, kOrg, kAppInstance.
osType This property is required. String
(String) Specifies the operating system type of the object.

  • Constraints: Allowable values are: kLinux, kWindows.
permissions This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermission>
(List) Specifies the list of users, groups and users that have permissions for a given object. Nested schema for permissions:
physicalParams This property is required. List<BackupRecoverySourceRegistrationSourceInfoPhysicalParam>
Specifies parameters to register physical server. Nested schema for physical_params:
protectionStats This property is required. List<BackupRecoverySourceRegistrationSourceInfoProtectionStat>
(List) Specifies the count and size of protected and unprotected objects for the size. Nested schema for protection_stats:
protectionType This property is required. String
(String) Specifies the protection type of the object if any.

  • Constraints: Allowable values are: kAgent, kNative, kSnapshotManager, kRDSSnapshotManager, kAuroraSnapshotManager, kAwsS3, kAwsRDSPostgresBackup, kAwsAuroraPostgres, kAwsRDSPostgres, kAzureSQL, kFile, kVolume.
sharepointSiteSummaries This property is required. List<BackupRecoverySourceRegistrationSourceInfoSharepointSiteSummary>
(List) Specifies the common parameters for Sharepoint site objects. Nested schema for sharepoint_site_summary:
sourceId This property is required. Double
(Integer) Specifies registered source id to which object belongs.
sourceName This property is required. String
(String) Specifies registered source name to which object belongs.
uuid This property is required. String
(String) Specifies the uuid which is a unique identifier of the object.
vCenterSummaries This property is required. List<BackupRecoverySourceRegistrationSourceInfoVCenterSummary>
(List) Nested schema for v_center_summary:
windowsClusterSummaries This property is required. List<BackupRecoverySourceRegistrationSourceInfoWindowsClusterSummary>
(List) Nested schema for windows_cluster_summary:
childObjects This property is required. BackupRecoverySourceRegistrationSourceInfoChildObject[]
(List) Specifies child object details. Nested schema for child_objects:
environment This property is required. string
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
globalId This property is required. string
(String) Specifies the global id which is a unique identifier of the object.
id This property is required. number
(String) The tenant id.
logicalSizeBytes This property is required. number
(Integer) Specifies the logical size of object in bytes.
mssqlParams This property is required. BackupRecoverySourceRegistrationSourceInfoMssqlParam[]
(List) Specifies the parameters for Msssql object. Nested schema for mssql_params:
name This property is required. string
The user specified name for this source.
objectHash This property is required. string
(String) Specifies the hash identifier of the object.
objectType This property is required. string
(String) Specifies the type of the object.

  • Constraints: Allowable values are: kCluster, kVserver, kVolume, kVCenter, kStandaloneHost, kvCloudDirector, kFolder, kDatacenter, kComputeResource, kClusterComputeResource, kResourcePool, kDatastore, kHostSystem, kVirtualMachine, kVirtualApp, kStoragePod, kNetwork, kDistributedVirtualPortgroup, kTagCategory, kTag, kOpaqueNetwork, kOrganization, kVirtualDatacenter, kCatalog, kOrgMetadata, kStoragePolicy, kVirtualAppTemplate, kDomain, kOutlook, kMailbox, kUsers, kGroups, kSites, kUser, kGroup, kSite, kApplication, kGraphUser, kPublicFolders, kPublicFolder, kTeams, kTeam, kRootPublicFolder, kO365Exchange, kO365OneDrive, kO365Sharepoint, kKeyspace, kTable, kDatabase, kCollection, kBucket, kNamespace, kSCVMMServer, kStandaloneCluster, kHostGroup, kHypervHost, kHostCluster, kCustomProperty, kTenant, kSubscription, kResourceGroup, kStorageAccount, kStorageKey, kStorageContainer, kStorageBlob, kNetworkSecurityGroup, kVirtualNetwork, kSubnet, kComputeOptions, kSnapshotManagerPermit, kAvailabilitySet, kOVirtManager, kHost, kStorageDomain, kVNicProfile, kIAMUser, kRegion, kAvailabilityZone, kEC2Instance, kVPC, kInstanceType, kKeyPair, kRDSOptionGroup, kRDSParameterGroup, kRDSInstance, kRDSSubnet, kRDSTag, kAuroraTag, kAuroraCluster, kAccount, kSubTaskPermit, kS3Bucket, kS3Tag, kKmsKey, kProject, kLabel, kMetadata, kVPCConnector, kPrismCentral, kOtherHypervisorCluster, kZone, kMountPoint, kStorageArray, kFileSystem, kContainer, kFilesystem, kFileset, kPureProtectionGroup, kVolumeGroup, kStoragePool, kViewBox, kView, kWindowsCluster, kOracleRACCluster, kOracleAPCluster, kService, kPVC, kPersistentVolumeClaim, kPersistentVolume, kRootContainer, kDAGRootContainer, kExchangeNode, kExchangeDAGDatabaseCopy, kExchangeStandaloneDatabase, kExchangeDAG, kExchangeDAGDatabase, kDomainController, kInstance, kAAG, kAAGRootContainer, kAAGDatabase, kRACRootContainer, kTableSpace, kPDB, kObject, kOrg, kAppInstance.
osType This property is required. string
(String) Specifies the operating system type of the object.

  • Constraints: Allowable values are: kLinux, kWindows.
permissions This property is required. BackupRecoverySourceRegistrationSourceInfoPermission[]
(List) Specifies the list of users, groups and users that have permissions for a given object. Nested schema for permissions:
physicalParams This property is required. BackupRecoverySourceRegistrationSourceInfoPhysicalParam[]
Specifies parameters to register physical server. Nested schema for physical_params:
protectionStats This property is required. BackupRecoverySourceRegistrationSourceInfoProtectionStat[]
(List) Specifies the count and size of protected and unprotected objects for the size. Nested schema for protection_stats:
protectionType This property is required. string
(String) Specifies the protection type of the object if any.

  • Constraints: Allowable values are: kAgent, kNative, kSnapshotManager, kRDSSnapshotManager, kAuroraSnapshotManager, kAwsS3, kAwsRDSPostgresBackup, kAwsAuroraPostgres, kAwsRDSPostgres, kAzureSQL, kFile, kVolume.
sharepointSiteSummaries This property is required. BackupRecoverySourceRegistrationSourceInfoSharepointSiteSummary[]
(List) Specifies the common parameters for Sharepoint site objects. Nested schema for sharepoint_site_summary:
sourceId This property is required. number
(Integer) Specifies registered source id to which object belongs.
sourceName This property is required. string
(String) Specifies registered source name to which object belongs.
uuid This property is required. string
(String) Specifies the uuid which is a unique identifier of the object.
vCenterSummaries This property is required. BackupRecoverySourceRegistrationSourceInfoVCenterSummary[]
(List) Nested schema for v_center_summary:
windowsClusterSummaries This property is required. BackupRecoverySourceRegistrationSourceInfoWindowsClusterSummary[]
(List) Nested schema for windows_cluster_summary:
child_objects This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoChildObject]
(List) Specifies child object details. Nested schema for child_objects:
environment This property is required. str
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
global_id This property is required. str
(String) Specifies the global id which is a unique identifier of the object.
id This property is required. float
(String) The tenant id.
logical_size_bytes This property is required. float
(Integer) Specifies the logical size of object in bytes.
mssql_params This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoMssqlParam]
(List) Specifies the parameters for Msssql object. Nested schema for mssql_params:
name This property is required. str
The user specified name for this source.
object_hash This property is required. str
(String) Specifies the hash identifier of the object.
object_type This property is required. str
(String) Specifies the type of the object.

  • Constraints: Allowable values are: kCluster, kVserver, kVolume, kVCenter, kStandaloneHost, kvCloudDirector, kFolder, kDatacenter, kComputeResource, kClusterComputeResource, kResourcePool, kDatastore, kHostSystem, kVirtualMachine, kVirtualApp, kStoragePod, kNetwork, kDistributedVirtualPortgroup, kTagCategory, kTag, kOpaqueNetwork, kOrganization, kVirtualDatacenter, kCatalog, kOrgMetadata, kStoragePolicy, kVirtualAppTemplate, kDomain, kOutlook, kMailbox, kUsers, kGroups, kSites, kUser, kGroup, kSite, kApplication, kGraphUser, kPublicFolders, kPublicFolder, kTeams, kTeam, kRootPublicFolder, kO365Exchange, kO365OneDrive, kO365Sharepoint, kKeyspace, kTable, kDatabase, kCollection, kBucket, kNamespace, kSCVMMServer, kStandaloneCluster, kHostGroup, kHypervHost, kHostCluster, kCustomProperty, kTenant, kSubscription, kResourceGroup, kStorageAccount, kStorageKey, kStorageContainer, kStorageBlob, kNetworkSecurityGroup, kVirtualNetwork, kSubnet, kComputeOptions, kSnapshotManagerPermit, kAvailabilitySet, kOVirtManager, kHost, kStorageDomain, kVNicProfile, kIAMUser, kRegion, kAvailabilityZone, kEC2Instance, kVPC, kInstanceType, kKeyPair, kRDSOptionGroup, kRDSParameterGroup, kRDSInstance, kRDSSubnet, kRDSTag, kAuroraTag, kAuroraCluster, kAccount, kSubTaskPermit, kS3Bucket, kS3Tag, kKmsKey, kProject, kLabel, kMetadata, kVPCConnector, kPrismCentral, kOtherHypervisorCluster, kZone, kMountPoint, kStorageArray, kFileSystem, kContainer, kFilesystem, kFileset, kPureProtectionGroup, kVolumeGroup, kStoragePool, kViewBox, kView, kWindowsCluster, kOracleRACCluster, kOracleAPCluster, kService, kPVC, kPersistentVolumeClaim, kPersistentVolume, kRootContainer, kDAGRootContainer, kExchangeNode, kExchangeDAGDatabaseCopy, kExchangeStandaloneDatabase, kExchangeDAG, kExchangeDAGDatabase, kDomainController, kInstance, kAAG, kAAGRootContainer, kAAGDatabase, kRACRootContainer, kTableSpace, kPDB, kObject, kOrg, kAppInstance.
os_type This property is required. str
(String) Specifies the operating system type of the object.

  • Constraints: Allowable values are: kLinux, kWindows.
permissions This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoPermission]
(List) Specifies the list of users, groups and users that have permissions for a given object. Nested schema for permissions:
physical_params This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoPhysicalParam]
Specifies parameters to register physical server. Nested schema for physical_params:
protection_stats This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoProtectionStat]
(List) Specifies the count and size of protected and unprotected objects for the size. Nested schema for protection_stats:
protection_type This property is required. str
(String) Specifies the protection type of the object if any.

  • Constraints: Allowable values are: kAgent, kNative, kSnapshotManager, kRDSSnapshotManager, kAuroraSnapshotManager, kAwsS3, kAwsRDSPostgresBackup, kAwsAuroraPostgres, kAwsRDSPostgres, kAzureSQL, kFile, kVolume.
sharepoint_site_summaries This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoSharepointSiteSummary]
(List) Specifies the common parameters for Sharepoint site objects. Nested schema for sharepoint_site_summary:
source_id This property is required. float
(Integer) Specifies registered source id to which object belongs.
source_name This property is required. str
(String) Specifies registered source name to which object belongs.
uuid This property is required. str
(String) Specifies the uuid which is a unique identifier of the object.
v_center_summaries This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoVCenterSummary]
(List) Nested schema for v_center_summary:
windows_cluster_summaries This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoWindowsClusterSummary]
(List) Nested schema for windows_cluster_summary:
childObjects This property is required. List<Property Map>
(List) Specifies child object details. Nested schema for child_objects:
environment This property is required. String
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
globalId This property is required. String
(String) Specifies the global id which is a unique identifier of the object.
id This property is required. Number
(String) The tenant id.
logicalSizeBytes This property is required. Number
(Integer) Specifies the logical size of object in bytes.
mssqlParams This property is required. List<Property Map>
(List) Specifies the parameters for Msssql object. Nested schema for mssql_params:
name This property is required. String
The user specified name for this source.
objectHash This property is required. String
(String) Specifies the hash identifier of the object.
objectType This property is required. String
(String) Specifies the type of the object.

  • Constraints: Allowable values are: kCluster, kVserver, kVolume, kVCenter, kStandaloneHost, kvCloudDirector, kFolder, kDatacenter, kComputeResource, kClusterComputeResource, kResourcePool, kDatastore, kHostSystem, kVirtualMachine, kVirtualApp, kStoragePod, kNetwork, kDistributedVirtualPortgroup, kTagCategory, kTag, kOpaqueNetwork, kOrganization, kVirtualDatacenter, kCatalog, kOrgMetadata, kStoragePolicy, kVirtualAppTemplate, kDomain, kOutlook, kMailbox, kUsers, kGroups, kSites, kUser, kGroup, kSite, kApplication, kGraphUser, kPublicFolders, kPublicFolder, kTeams, kTeam, kRootPublicFolder, kO365Exchange, kO365OneDrive, kO365Sharepoint, kKeyspace, kTable, kDatabase, kCollection, kBucket, kNamespace, kSCVMMServer, kStandaloneCluster, kHostGroup, kHypervHost, kHostCluster, kCustomProperty, kTenant, kSubscription, kResourceGroup, kStorageAccount, kStorageKey, kStorageContainer, kStorageBlob, kNetworkSecurityGroup, kVirtualNetwork, kSubnet, kComputeOptions, kSnapshotManagerPermit, kAvailabilitySet, kOVirtManager, kHost, kStorageDomain, kVNicProfile, kIAMUser, kRegion, kAvailabilityZone, kEC2Instance, kVPC, kInstanceType, kKeyPair, kRDSOptionGroup, kRDSParameterGroup, kRDSInstance, kRDSSubnet, kRDSTag, kAuroraTag, kAuroraCluster, kAccount, kSubTaskPermit, kS3Bucket, kS3Tag, kKmsKey, kProject, kLabel, kMetadata, kVPCConnector, kPrismCentral, kOtherHypervisorCluster, kZone, kMountPoint, kStorageArray, kFileSystem, kContainer, kFilesystem, kFileset, kPureProtectionGroup, kVolumeGroup, kStoragePool, kViewBox, kView, kWindowsCluster, kOracleRACCluster, kOracleAPCluster, kService, kPVC, kPersistentVolumeClaim, kPersistentVolume, kRootContainer, kDAGRootContainer, kExchangeNode, kExchangeDAGDatabaseCopy, kExchangeStandaloneDatabase, kExchangeDAG, kExchangeDAGDatabase, kDomainController, kInstance, kAAG, kAAGRootContainer, kAAGDatabase, kRACRootContainer, kTableSpace, kPDB, kObject, kOrg, kAppInstance.
osType This property is required. String
(String) Specifies the operating system type of the object.

  • Constraints: Allowable values are: kLinux, kWindows.
permissions This property is required. List<Property Map>
(List) Specifies the list of users, groups and users that have permissions for a given object. Nested schema for permissions:
physicalParams This property is required. List<Property Map>
Specifies parameters to register physical server. Nested schema for physical_params:
protectionStats This property is required. List<Property Map>
(List) Specifies the count and size of protected and unprotected objects for the size. Nested schema for protection_stats:
protectionType This property is required. String
(String) Specifies the protection type of the object if any.

  • Constraints: Allowable values are: kAgent, kNative, kSnapshotManager, kRDSSnapshotManager, kAuroraSnapshotManager, kAwsS3, kAwsRDSPostgresBackup, kAwsAuroraPostgres, kAwsRDSPostgres, kAzureSQL, kFile, kVolume.
sharepointSiteSummaries This property is required. List<Property Map>
(List) Specifies the common parameters for Sharepoint site objects. Nested schema for sharepoint_site_summary:
sourceId This property is required. Number
(Integer) Specifies registered source id to which object belongs.
sourceName This property is required. String
(String) Specifies registered source name to which object belongs.
uuid This property is required. String
(String) Specifies the uuid which is a unique identifier of the object.
vCenterSummaries This property is required. List<Property Map>
(List) Nested schema for v_center_summary:
windowsClusterSummaries This property is required. List<Property Map>
(List) Nested schema for windows_cluster_summary:

BackupRecoverySourceRegistrationSourceInfoChildObject
, BackupRecoverySourceRegistrationSourceInfoChildObjectArgs

ChildObjects This property is required. List<BackupRecoverySourceRegistrationSourceInfoChildObjectChildObject>
(List) Specifies child object details. Nested schema for child_objects:
Environment This property is required. string
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
GlobalId This property is required. string
(String) Specifies the global id which is a unique identifier of the object.
Id This property is required. double
(String) The tenant id.
LogicalSizeBytes This property is required. double
(Integer) Specifies the logical size of object in bytes.
Name This property is required. string
The user specified name for this source.
ObjectHash This property is required. string
(String) Specifies the hash identifier of the object.
ObjectType This property is required. string
(String) Specifies the type of the object.

  • Constraints: Allowable values are: kCluster, kVserver, kVolume, kVCenter, kStandaloneHost, kvCloudDirector, kFolder, kDatacenter, kComputeResource, kClusterComputeResource, kResourcePool, kDatastore, kHostSystem, kVirtualMachine, kVirtualApp, kStoragePod, kNetwork, kDistributedVirtualPortgroup, kTagCategory, kTag, kOpaqueNetwork, kOrganization, kVirtualDatacenter, kCatalog, kOrgMetadata, kStoragePolicy, kVirtualAppTemplate, kDomain, kOutlook, kMailbox, kUsers, kGroups, kSites, kUser, kGroup, kSite, kApplication, kGraphUser, kPublicFolders, kPublicFolder, kTeams, kTeam, kRootPublicFolder, kO365Exchange, kO365OneDrive, kO365Sharepoint, kKeyspace, kTable, kDatabase, kCollection, kBucket, kNamespace, kSCVMMServer, kStandaloneCluster, kHostGroup, kHypervHost, kHostCluster, kCustomProperty, kTenant, kSubscription, kResourceGroup, kStorageAccount, kStorageKey, kStorageContainer, kStorageBlob, kNetworkSecurityGroup, kVirtualNetwork, kSubnet, kComputeOptions, kSnapshotManagerPermit, kAvailabilitySet, kOVirtManager, kHost, kStorageDomain, kVNicProfile, kIAMUser, kRegion, kAvailabilityZone, kEC2Instance, kVPC, kInstanceType, kKeyPair, kRDSOptionGroup, kRDSParameterGroup, kRDSInstance, kRDSSubnet, kRDSTag, kAuroraTag, kAuroraCluster, kAccount, kSubTaskPermit, kS3Bucket, kS3Tag, kKmsKey, kProject, kLabel, kMetadata, kVPCConnector, kPrismCentral, kOtherHypervisorCluster, kZone, kMountPoint, kStorageArray, kFileSystem, kContainer, kFilesystem, kFileset, kPureProtectionGroup, kVolumeGroup, kStoragePool, kViewBox, kView, kWindowsCluster, kOracleRACCluster, kOracleAPCluster, kService, kPVC, kPersistentVolumeClaim, kPersistentVolume, kRootContainer, kDAGRootContainer, kExchangeNode, kExchangeDAGDatabaseCopy, kExchangeStandaloneDatabase, kExchangeDAG, kExchangeDAGDatabase, kDomainController, kInstance, kAAG, kAAGRootContainer, kAAGDatabase, kRACRootContainer, kTableSpace, kPDB, kObject, kOrg, kAppInstance.
OsType This property is required. string
(String) Specifies the operating system type of the object.

  • Constraints: Allowable values are: kLinux, kWindows.
ProtectionType This property is required. string
(String) Specifies the protection type of the object if any.

  • Constraints: Allowable values are: kAgent, kNative, kSnapshotManager, kRDSSnapshotManager, kAuroraSnapshotManager, kAwsS3, kAwsRDSPostgresBackup, kAwsAuroraPostgres, kAwsRDSPostgres, kAzureSQL, kFile, kVolume.
SharepointSiteSummaries This property is required. List<BackupRecoverySourceRegistrationSourceInfoChildObjectSharepointSiteSummary>
(List) Specifies the common parameters for Sharepoint site objects. Nested schema for sharepoint_site_summary:
SourceId This property is required. double
(Integer) Specifies registered source id to which object belongs.
SourceName This property is required. string
(String) Specifies registered source name to which object belongs.
Uuid This property is required. string
(String) Specifies the uuid which is a unique identifier of the object.
VCenterSummaries This property is required. List<BackupRecoverySourceRegistrationSourceInfoChildObjectVCenterSummary>
(List) Nested schema for v_center_summary:
WindowsClusterSummaries This property is required. List<BackupRecoverySourceRegistrationSourceInfoChildObjectWindowsClusterSummary>
(List) Nested schema for windows_cluster_summary:
ChildObjects This property is required. []BackupRecoverySourceRegistrationSourceInfoChildObjectChildObject
(List) Specifies child object details. Nested schema for child_objects:
Environment This property is required. string
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
GlobalId This property is required. string
(String) Specifies the global id which is a unique identifier of the object.
Id This property is required. float64
(String) The tenant id.
LogicalSizeBytes This property is required. float64
(Integer) Specifies the logical size of object in bytes.
Name This property is required. string
The user specified name for this source.
ObjectHash This property is required. string
(String) Specifies the hash identifier of the object.
ObjectType This property is required. string
(String) Specifies the type of the object.

  • Constraints: Allowable values are: kCluster, kVserver, kVolume, kVCenter, kStandaloneHost, kvCloudDirector, kFolder, kDatacenter, kComputeResource, kClusterComputeResource, kResourcePool, kDatastore, kHostSystem, kVirtualMachine, kVirtualApp, kStoragePod, kNetwork, kDistributedVirtualPortgroup, kTagCategory, kTag, kOpaqueNetwork, kOrganization, kVirtualDatacenter, kCatalog, kOrgMetadata, kStoragePolicy, kVirtualAppTemplate, kDomain, kOutlook, kMailbox, kUsers, kGroups, kSites, kUser, kGroup, kSite, kApplication, kGraphUser, kPublicFolders, kPublicFolder, kTeams, kTeam, kRootPublicFolder, kO365Exchange, kO365OneDrive, kO365Sharepoint, kKeyspace, kTable, kDatabase, kCollection, kBucket, kNamespace, kSCVMMServer, kStandaloneCluster, kHostGroup, kHypervHost, kHostCluster, kCustomProperty, kTenant, kSubscription, kResourceGroup, kStorageAccount, kStorageKey, kStorageContainer, kStorageBlob, kNetworkSecurityGroup, kVirtualNetwork, kSubnet, kComputeOptions, kSnapshotManagerPermit, kAvailabilitySet, kOVirtManager, kHost, kStorageDomain, kVNicProfile, kIAMUser, kRegion, kAvailabilityZone, kEC2Instance, kVPC, kInstanceType, kKeyPair, kRDSOptionGroup, kRDSParameterGroup, kRDSInstance, kRDSSubnet, kRDSTag, kAuroraTag, kAuroraCluster, kAccount, kSubTaskPermit, kS3Bucket, kS3Tag, kKmsKey, kProject, kLabel, kMetadata, kVPCConnector, kPrismCentral, kOtherHypervisorCluster, kZone, kMountPoint, kStorageArray, kFileSystem, kContainer, kFilesystem, kFileset, kPureProtectionGroup, kVolumeGroup, kStoragePool, kViewBox, kView, kWindowsCluster, kOracleRACCluster, kOracleAPCluster, kService, kPVC, kPersistentVolumeClaim, kPersistentVolume, kRootContainer, kDAGRootContainer, kExchangeNode, kExchangeDAGDatabaseCopy, kExchangeStandaloneDatabase, kExchangeDAG, kExchangeDAGDatabase, kDomainController, kInstance, kAAG, kAAGRootContainer, kAAGDatabase, kRACRootContainer, kTableSpace, kPDB, kObject, kOrg, kAppInstance.
OsType This property is required. string
(String) Specifies the operating system type of the object.

  • Constraints: Allowable values are: kLinux, kWindows.
ProtectionType This property is required. string
(String) Specifies the protection type of the object if any.

  • Constraints: Allowable values are: kAgent, kNative, kSnapshotManager, kRDSSnapshotManager, kAuroraSnapshotManager, kAwsS3, kAwsRDSPostgresBackup, kAwsAuroraPostgres, kAwsRDSPostgres, kAzureSQL, kFile, kVolume.
SharepointSiteSummaries This property is required. []BackupRecoverySourceRegistrationSourceInfoChildObjectSharepointSiteSummary
(List) Specifies the common parameters for Sharepoint site objects. Nested schema for sharepoint_site_summary:
SourceId This property is required. float64
(Integer) Specifies registered source id to which object belongs.
SourceName This property is required. string
(String) Specifies registered source name to which object belongs.
Uuid This property is required. string
(String) Specifies the uuid which is a unique identifier of the object.
VCenterSummaries This property is required. []BackupRecoverySourceRegistrationSourceInfoChildObjectVCenterSummary
(List) Nested schema for v_center_summary:
WindowsClusterSummaries This property is required. []BackupRecoverySourceRegistrationSourceInfoChildObjectWindowsClusterSummary
(List) Nested schema for windows_cluster_summary:
childObjects This property is required. List<BackupRecoverySourceRegistrationSourceInfoChildObjectChildObject>
(List) Specifies child object details. Nested schema for child_objects:
environment This property is required. String
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
globalId This property is required. String
(String) Specifies the global id which is a unique identifier of the object.
id This property is required. Double
(String) The tenant id.
logicalSizeBytes This property is required. Double
(Integer) Specifies the logical size of object in bytes.
name This property is required. String
The user specified name for this source.
objectHash This property is required. String
(String) Specifies the hash identifier of the object.
objectType This property is required. String
(String) Specifies the type of the object.

  • Constraints: Allowable values are: kCluster, kVserver, kVolume, kVCenter, kStandaloneHost, kvCloudDirector, kFolder, kDatacenter, kComputeResource, kClusterComputeResource, kResourcePool, kDatastore, kHostSystem, kVirtualMachine, kVirtualApp, kStoragePod, kNetwork, kDistributedVirtualPortgroup, kTagCategory, kTag, kOpaqueNetwork, kOrganization, kVirtualDatacenter, kCatalog, kOrgMetadata, kStoragePolicy, kVirtualAppTemplate, kDomain, kOutlook, kMailbox, kUsers, kGroups, kSites, kUser, kGroup, kSite, kApplication, kGraphUser, kPublicFolders, kPublicFolder, kTeams, kTeam, kRootPublicFolder, kO365Exchange, kO365OneDrive, kO365Sharepoint, kKeyspace, kTable, kDatabase, kCollection, kBucket, kNamespace, kSCVMMServer, kStandaloneCluster, kHostGroup, kHypervHost, kHostCluster, kCustomProperty, kTenant, kSubscription, kResourceGroup, kStorageAccount, kStorageKey, kStorageContainer, kStorageBlob, kNetworkSecurityGroup, kVirtualNetwork, kSubnet, kComputeOptions, kSnapshotManagerPermit, kAvailabilitySet, kOVirtManager, kHost, kStorageDomain, kVNicProfile, kIAMUser, kRegion, kAvailabilityZone, kEC2Instance, kVPC, kInstanceType, kKeyPair, kRDSOptionGroup, kRDSParameterGroup, kRDSInstance, kRDSSubnet, kRDSTag, kAuroraTag, kAuroraCluster, kAccount, kSubTaskPermit, kS3Bucket, kS3Tag, kKmsKey, kProject, kLabel, kMetadata, kVPCConnector, kPrismCentral, kOtherHypervisorCluster, kZone, kMountPoint, kStorageArray, kFileSystem, kContainer, kFilesystem, kFileset, kPureProtectionGroup, kVolumeGroup, kStoragePool, kViewBox, kView, kWindowsCluster, kOracleRACCluster, kOracleAPCluster, kService, kPVC, kPersistentVolumeClaim, kPersistentVolume, kRootContainer, kDAGRootContainer, kExchangeNode, kExchangeDAGDatabaseCopy, kExchangeStandaloneDatabase, kExchangeDAG, kExchangeDAGDatabase, kDomainController, kInstance, kAAG, kAAGRootContainer, kAAGDatabase, kRACRootContainer, kTableSpace, kPDB, kObject, kOrg, kAppInstance.
osType This property is required. String
(String) Specifies the operating system type of the object.

  • Constraints: Allowable values are: kLinux, kWindows.
protectionType This property is required. String
(String) Specifies the protection type of the object if any.

  • Constraints: Allowable values are: kAgent, kNative, kSnapshotManager, kRDSSnapshotManager, kAuroraSnapshotManager, kAwsS3, kAwsRDSPostgresBackup, kAwsAuroraPostgres, kAwsRDSPostgres, kAzureSQL, kFile, kVolume.
sharepointSiteSummaries This property is required. List<BackupRecoverySourceRegistrationSourceInfoChildObjectSharepointSiteSummary>
(List) Specifies the common parameters for Sharepoint site objects. Nested schema for sharepoint_site_summary:
sourceId This property is required. Double
(Integer) Specifies registered source id to which object belongs.
sourceName This property is required. String
(String) Specifies registered source name to which object belongs.
uuid This property is required. String
(String) Specifies the uuid which is a unique identifier of the object.
vCenterSummaries This property is required. List<BackupRecoverySourceRegistrationSourceInfoChildObjectVCenterSummary>
(List) Nested schema for v_center_summary:
windowsClusterSummaries This property is required. List<BackupRecoverySourceRegistrationSourceInfoChildObjectWindowsClusterSummary>
(List) Nested schema for windows_cluster_summary:
childObjects This property is required. BackupRecoverySourceRegistrationSourceInfoChildObjectChildObject[]
(List) Specifies child object details. Nested schema for child_objects:
environment This property is required. string
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
globalId This property is required. string
(String) Specifies the global id which is a unique identifier of the object.
id This property is required. number
(String) The tenant id.
logicalSizeBytes This property is required. number
(Integer) Specifies the logical size of object in bytes.
name This property is required. string
The user specified name for this source.
objectHash This property is required. string
(String) Specifies the hash identifier of the object.
objectType This property is required. string
(String) Specifies the type of the object.

  • Constraints: Allowable values are: kCluster, kVserver, kVolume, kVCenter, kStandaloneHost, kvCloudDirector, kFolder, kDatacenter, kComputeResource, kClusterComputeResource, kResourcePool, kDatastore, kHostSystem, kVirtualMachine, kVirtualApp, kStoragePod, kNetwork, kDistributedVirtualPortgroup, kTagCategory, kTag, kOpaqueNetwork, kOrganization, kVirtualDatacenter, kCatalog, kOrgMetadata, kStoragePolicy, kVirtualAppTemplate, kDomain, kOutlook, kMailbox, kUsers, kGroups, kSites, kUser, kGroup, kSite, kApplication, kGraphUser, kPublicFolders, kPublicFolder, kTeams, kTeam, kRootPublicFolder, kO365Exchange, kO365OneDrive, kO365Sharepoint, kKeyspace, kTable, kDatabase, kCollection, kBucket, kNamespace, kSCVMMServer, kStandaloneCluster, kHostGroup, kHypervHost, kHostCluster, kCustomProperty, kTenant, kSubscription, kResourceGroup, kStorageAccount, kStorageKey, kStorageContainer, kStorageBlob, kNetworkSecurityGroup, kVirtualNetwork, kSubnet, kComputeOptions, kSnapshotManagerPermit, kAvailabilitySet, kOVirtManager, kHost, kStorageDomain, kVNicProfile, kIAMUser, kRegion, kAvailabilityZone, kEC2Instance, kVPC, kInstanceType, kKeyPair, kRDSOptionGroup, kRDSParameterGroup, kRDSInstance, kRDSSubnet, kRDSTag, kAuroraTag, kAuroraCluster, kAccount, kSubTaskPermit, kS3Bucket, kS3Tag, kKmsKey, kProject, kLabel, kMetadata, kVPCConnector, kPrismCentral, kOtherHypervisorCluster, kZone, kMountPoint, kStorageArray, kFileSystem, kContainer, kFilesystem, kFileset, kPureProtectionGroup, kVolumeGroup, kStoragePool, kViewBox, kView, kWindowsCluster, kOracleRACCluster, kOracleAPCluster, kService, kPVC, kPersistentVolumeClaim, kPersistentVolume, kRootContainer, kDAGRootContainer, kExchangeNode, kExchangeDAGDatabaseCopy, kExchangeStandaloneDatabase, kExchangeDAG, kExchangeDAGDatabase, kDomainController, kInstance, kAAG, kAAGRootContainer, kAAGDatabase, kRACRootContainer, kTableSpace, kPDB, kObject, kOrg, kAppInstance.
osType This property is required. string
(String) Specifies the operating system type of the object.

  • Constraints: Allowable values are: kLinux, kWindows.
protectionType This property is required. string
(String) Specifies the protection type of the object if any.

  • Constraints: Allowable values are: kAgent, kNative, kSnapshotManager, kRDSSnapshotManager, kAuroraSnapshotManager, kAwsS3, kAwsRDSPostgresBackup, kAwsAuroraPostgres, kAwsRDSPostgres, kAzureSQL, kFile, kVolume.
sharepointSiteSummaries This property is required. BackupRecoverySourceRegistrationSourceInfoChildObjectSharepointSiteSummary[]
(List) Specifies the common parameters for Sharepoint site objects. Nested schema for sharepoint_site_summary:
sourceId This property is required. number
(Integer) Specifies registered source id to which object belongs.
sourceName This property is required. string
(String) Specifies registered source name to which object belongs.
uuid This property is required. string
(String) Specifies the uuid which is a unique identifier of the object.
vCenterSummaries This property is required. BackupRecoverySourceRegistrationSourceInfoChildObjectVCenterSummary[]
(List) Nested schema for v_center_summary:
windowsClusterSummaries This property is required. BackupRecoverySourceRegistrationSourceInfoChildObjectWindowsClusterSummary[]
(List) Nested schema for windows_cluster_summary:
child_objects This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoChildObjectChildObject]
(List) Specifies child object details. Nested schema for child_objects:
environment This property is required. str
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
global_id This property is required. str
(String) Specifies the global id which is a unique identifier of the object.
id This property is required. float
(String) The tenant id.
logical_size_bytes This property is required. float
(Integer) Specifies the logical size of object in bytes.
name This property is required. str
The user specified name for this source.
object_hash This property is required. str
(String) Specifies the hash identifier of the object.
object_type This property is required. str
(String) Specifies the type of the object.

  • Constraints: Allowable values are: kCluster, kVserver, kVolume, kVCenter, kStandaloneHost, kvCloudDirector, kFolder, kDatacenter, kComputeResource, kClusterComputeResource, kResourcePool, kDatastore, kHostSystem, kVirtualMachine, kVirtualApp, kStoragePod, kNetwork, kDistributedVirtualPortgroup, kTagCategory, kTag, kOpaqueNetwork, kOrganization, kVirtualDatacenter, kCatalog, kOrgMetadata, kStoragePolicy, kVirtualAppTemplate, kDomain, kOutlook, kMailbox, kUsers, kGroups, kSites, kUser, kGroup, kSite, kApplication, kGraphUser, kPublicFolders, kPublicFolder, kTeams, kTeam, kRootPublicFolder, kO365Exchange, kO365OneDrive, kO365Sharepoint, kKeyspace, kTable, kDatabase, kCollection, kBucket, kNamespace, kSCVMMServer, kStandaloneCluster, kHostGroup, kHypervHost, kHostCluster, kCustomProperty, kTenant, kSubscription, kResourceGroup, kStorageAccount, kStorageKey, kStorageContainer, kStorageBlob, kNetworkSecurityGroup, kVirtualNetwork, kSubnet, kComputeOptions, kSnapshotManagerPermit, kAvailabilitySet, kOVirtManager, kHost, kStorageDomain, kVNicProfile, kIAMUser, kRegion, kAvailabilityZone, kEC2Instance, kVPC, kInstanceType, kKeyPair, kRDSOptionGroup, kRDSParameterGroup, kRDSInstance, kRDSSubnet, kRDSTag, kAuroraTag, kAuroraCluster, kAccount, kSubTaskPermit, kS3Bucket, kS3Tag, kKmsKey, kProject, kLabel, kMetadata, kVPCConnector, kPrismCentral, kOtherHypervisorCluster, kZone, kMountPoint, kStorageArray, kFileSystem, kContainer, kFilesystem, kFileset, kPureProtectionGroup, kVolumeGroup, kStoragePool, kViewBox, kView, kWindowsCluster, kOracleRACCluster, kOracleAPCluster, kService, kPVC, kPersistentVolumeClaim, kPersistentVolume, kRootContainer, kDAGRootContainer, kExchangeNode, kExchangeDAGDatabaseCopy, kExchangeStandaloneDatabase, kExchangeDAG, kExchangeDAGDatabase, kDomainController, kInstance, kAAG, kAAGRootContainer, kAAGDatabase, kRACRootContainer, kTableSpace, kPDB, kObject, kOrg, kAppInstance.
os_type This property is required. str
(String) Specifies the operating system type of the object.

  • Constraints: Allowable values are: kLinux, kWindows.
protection_type This property is required. str
(String) Specifies the protection type of the object if any.

  • Constraints: Allowable values are: kAgent, kNative, kSnapshotManager, kRDSSnapshotManager, kAuroraSnapshotManager, kAwsS3, kAwsRDSPostgresBackup, kAwsAuroraPostgres, kAwsRDSPostgres, kAzureSQL, kFile, kVolume.
sharepoint_site_summaries This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoChildObjectSharepointSiteSummary]
(List) Specifies the common parameters for Sharepoint site objects. Nested schema for sharepoint_site_summary:
source_id This property is required. float
(Integer) Specifies registered source id to which object belongs.
source_name This property is required. str
(String) Specifies registered source name to which object belongs.
uuid This property is required. str
(String) Specifies the uuid which is a unique identifier of the object.
v_center_summaries This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoChildObjectVCenterSummary]
(List) Nested schema for v_center_summary:
windows_cluster_summaries This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoChildObjectWindowsClusterSummary]
(List) Nested schema for windows_cluster_summary:
childObjects This property is required. List<Property Map>
(List) Specifies child object details. Nested schema for child_objects:
environment This property is required. String
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
globalId This property is required. String
(String) Specifies the global id which is a unique identifier of the object.
id This property is required. Number
(String) The tenant id.
logicalSizeBytes This property is required. Number
(Integer) Specifies the logical size of object in bytes.
name This property is required. String
The user specified name for this source.
objectHash This property is required. String
(String) Specifies the hash identifier of the object.
objectType This property is required. String
(String) Specifies the type of the object.

  • Constraints: Allowable values are: kCluster, kVserver, kVolume, kVCenter, kStandaloneHost, kvCloudDirector, kFolder, kDatacenter, kComputeResource, kClusterComputeResource, kResourcePool, kDatastore, kHostSystem, kVirtualMachine, kVirtualApp, kStoragePod, kNetwork, kDistributedVirtualPortgroup, kTagCategory, kTag, kOpaqueNetwork, kOrganization, kVirtualDatacenter, kCatalog, kOrgMetadata, kStoragePolicy, kVirtualAppTemplate, kDomain, kOutlook, kMailbox, kUsers, kGroups, kSites, kUser, kGroup, kSite, kApplication, kGraphUser, kPublicFolders, kPublicFolder, kTeams, kTeam, kRootPublicFolder, kO365Exchange, kO365OneDrive, kO365Sharepoint, kKeyspace, kTable, kDatabase, kCollection, kBucket, kNamespace, kSCVMMServer, kStandaloneCluster, kHostGroup, kHypervHost, kHostCluster, kCustomProperty, kTenant, kSubscription, kResourceGroup, kStorageAccount, kStorageKey, kStorageContainer, kStorageBlob, kNetworkSecurityGroup, kVirtualNetwork, kSubnet, kComputeOptions, kSnapshotManagerPermit, kAvailabilitySet, kOVirtManager, kHost, kStorageDomain, kVNicProfile, kIAMUser, kRegion, kAvailabilityZone, kEC2Instance, kVPC, kInstanceType, kKeyPair, kRDSOptionGroup, kRDSParameterGroup, kRDSInstance, kRDSSubnet, kRDSTag, kAuroraTag, kAuroraCluster, kAccount, kSubTaskPermit, kS3Bucket, kS3Tag, kKmsKey, kProject, kLabel, kMetadata, kVPCConnector, kPrismCentral, kOtherHypervisorCluster, kZone, kMountPoint, kStorageArray, kFileSystem, kContainer, kFilesystem, kFileset, kPureProtectionGroup, kVolumeGroup, kStoragePool, kViewBox, kView, kWindowsCluster, kOracleRACCluster, kOracleAPCluster, kService, kPVC, kPersistentVolumeClaim, kPersistentVolume, kRootContainer, kDAGRootContainer, kExchangeNode, kExchangeDAGDatabaseCopy, kExchangeStandaloneDatabase, kExchangeDAG, kExchangeDAGDatabase, kDomainController, kInstance, kAAG, kAAGRootContainer, kAAGDatabase, kRACRootContainer, kTableSpace, kPDB, kObject, kOrg, kAppInstance.
osType This property is required. String
(String) Specifies the operating system type of the object.

  • Constraints: Allowable values are: kLinux, kWindows.
protectionType This property is required. String
(String) Specifies the protection type of the object if any.

  • Constraints: Allowable values are: kAgent, kNative, kSnapshotManager, kRDSSnapshotManager, kAuroraSnapshotManager, kAwsS3, kAwsRDSPostgresBackup, kAwsAuroraPostgres, kAwsRDSPostgres, kAzureSQL, kFile, kVolume.
sharepointSiteSummaries This property is required. List<Property Map>
(List) Specifies the common parameters for Sharepoint site objects. Nested schema for sharepoint_site_summary:
sourceId This property is required. Number
(Integer) Specifies registered source id to which object belongs.
sourceName This property is required. String
(String) Specifies registered source name to which object belongs.
uuid This property is required. String
(String) Specifies the uuid which is a unique identifier of the object.
vCenterSummaries This property is required. List<Property Map>
(List) Nested schema for v_center_summary:
windowsClusterSummaries This property is required. List<Property Map>
(List) Nested schema for windows_cluster_summary:

BackupRecoverySourceRegistrationSourceInfoChildObjectSharepointSiteSummary
, BackupRecoverySourceRegistrationSourceInfoChildObjectSharepointSiteSummaryArgs

SiteWebUrl This property is required. string
(String) Specifies the web url for the Sharepoint site.
SiteWebUrl This property is required. string
(String) Specifies the web url for the Sharepoint site.
siteWebUrl This property is required. String
(String) Specifies the web url for the Sharepoint site.
siteWebUrl This property is required. string
(String) Specifies the web url for the Sharepoint site.
site_web_url This property is required. str
(String) Specifies the web url for the Sharepoint site.
siteWebUrl This property is required. String
(String) Specifies the web url for the Sharepoint site.

BackupRecoverySourceRegistrationSourceInfoChildObjectVCenterSummary
, BackupRecoverySourceRegistrationSourceInfoChildObjectVCenterSummaryArgs

IsCloudEnv This property is required. bool
(Boolean) Specifies that registered vCenter source is a VMC (VMware Cloud) environment or not.
IsCloudEnv This property is required. bool
(Boolean) Specifies that registered vCenter source is a VMC (VMware Cloud) environment or not.
isCloudEnv This property is required. Boolean
(Boolean) Specifies that registered vCenter source is a VMC (VMware Cloud) environment or not.
isCloudEnv This property is required. boolean
(Boolean) Specifies that registered vCenter source is a VMC (VMware Cloud) environment or not.
is_cloud_env This property is required. bool
(Boolean) Specifies that registered vCenter source is a VMC (VMware Cloud) environment or not.
isCloudEnv This property is required. Boolean
(Boolean) Specifies that registered vCenter source is a VMC (VMware Cloud) environment or not.

BackupRecoverySourceRegistrationSourceInfoChildObjectWindowsClusterSummary
, BackupRecoverySourceRegistrationSourceInfoChildObjectWindowsClusterSummaryArgs

ClusterSourceType This property is required. string
(String) Specifies the type of cluster resource this source represents.
ClusterSourceType This property is required. string
(String) Specifies the type of cluster resource this source represents.
clusterSourceType This property is required. String
(String) Specifies the type of cluster resource this source represents.
clusterSourceType This property is required. string
(String) Specifies the type of cluster resource this source represents.
cluster_source_type This property is required. str
(String) Specifies the type of cluster resource this source represents.
clusterSourceType This property is required. String
(String) Specifies the type of cluster resource this source represents.

BackupRecoverySourceRegistrationSourceInfoMssqlParam
, BackupRecoverySourceRegistrationSourceInfoMssqlParamArgs

AagInfos This property is required. List<BackupRecoverySourceRegistrationSourceInfoMssqlParamAagInfo>
(List) Object details for Mssql. Nested schema for aag_info:
HostInfos This property is required. List<BackupRecoverySourceRegistrationSourceInfoMssqlParamHostInfo>
(List) Specifies the host information for a objects. This is mainly populated in case of App objects where app object is hosted by another object such as VM or physical server. Nested schema for host_info:
IsEncrypted This property is required. bool
(Boolean) Specifies whether the database is TDE enabled.
AagInfos This property is required. []BackupRecoverySourceRegistrationSourceInfoMssqlParamAagInfo
(List) Object details for Mssql. Nested schema for aag_info:
HostInfos This property is required. []BackupRecoverySourceRegistrationSourceInfoMssqlParamHostInfo
(List) Specifies the host information for a objects. This is mainly populated in case of App objects where app object is hosted by another object such as VM or physical server. Nested schema for host_info:
IsEncrypted This property is required. bool
(Boolean) Specifies whether the database is TDE enabled.
aagInfos This property is required. List<BackupRecoverySourceRegistrationSourceInfoMssqlParamAagInfo>
(List) Object details for Mssql. Nested schema for aag_info:
hostInfos This property is required. List<BackupRecoverySourceRegistrationSourceInfoMssqlParamHostInfo>
(List) Specifies the host information for a objects. This is mainly populated in case of App objects where app object is hosted by another object such as VM or physical server. Nested schema for host_info:
isEncrypted This property is required. Boolean
(Boolean) Specifies whether the database is TDE enabled.
aagInfos This property is required. BackupRecoverySourceRegistrationSourceInfoMssqlParamAagInfo[]
(List) Object details for Mssql. Nested schema for aag_info:
hostInfos This property is required. BackupRecoverySourceRegistrationSourceInfoMssqlParamHostInfo[]
(List) Specifies the host information for a objects. This is mainly populated in case of App objects where app object is hosted by another object such as VM or physical server. Nested schema for host_info:
isEncrypted This property is required. boolean
(Boolean) Specifies whether the database is TDE enabled.
aag_infos This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoMssqlParamAagInfo]
(List) Object details for Mssql. Nested schema for aag_info:
host_infos This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoMssqlParamHostInfo]
(List) Specifies the host information for a objects. This is mainly populated in case of App objects where app object is hosted by another object such as VM or physical server. Nested schema for host_info:
is_encrypted This property is required. bool
(Boolean) Specifies whether the database is TDE enabled.
aagInfos This property is required. List<Property Map>
(List) Object details for Mssql. Nested schema for aag_info:
hostInfos This property is required. List<Property Map>
(List) Specifies the host information for a objects. This is mainly populated in case of App objects where app object is hosted by another object such as VM or physical server. Nested schema for host_info:
isEncrypted This property is required. Boolean
(Boolean) Specifies whether the database is TDE enabled.

BackupRecoverySourceRegistrationSourceInfoMssqlParamAagInfo
, BackupRecoverySourceRegistrationSourceInfoMssqlParamAagInfoArgs

Name This property is required. string
The user specified name for this source.
ObjectId This property is required. double
(Integer) Specifies the id of the object.
Name This property is required. string
The user specified name for this source.
ObjectId This property is required. float64
(Integer) Specifies the id of the object.
name This property is required. String
The user specified name for this source.
objectId This property is required. Double
(Integer) Specifies the id of the object.
name This property is required. string
The user specified name for this source.
objectId This property is required. number
(Integer) Specifies the id of the object.
name This property is required. str
The user specified name for this source.
object_id This property is required. float
(Integer) Specifies the id of the object.
name This property is required. String
The user specified name for this source.
objectId This property is required. Number
(Integer) Specifies the id of the object.

BackupRecoverySourceRegistrationSourceInfoMssqlParamHostInfo
, BackupRecoverySourceRegistrationSourceInfoMssqlParamHostInfoArgs

Environment This property is required. string
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
Id This property is required. string
(String) The tenant id.
Name This property is required. string
The user specified name for this source.
Environment This property is required. string
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
Id This property is required. string
(String) The tenant id.
Name This property is required. string
The user specified name for this source.
environment This property is required. String
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
id This property is required. String
(String) The tenant id.
name This property is required. String
The user specified name for this source.
environment This property is required. string
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
id This property is required. string
(String) The tenant id.
name This property is required. string
The user specified name for this source.
environment This property is required. str
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
id This property is required. str
(String) The tenant id.
name This property is required. str
The user specified name for this source.
environment This property is required. String
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
id This property is required. String
(String) The tenant id.
name This property is required. String
The user specified name for this source.

BackupRecoverySourceRegistrationSourceInfoPermission
, BackupRecoverySourceRegistrationSourceInfoPermissionArgs

Groups This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionGroup>
(List) Specifies the list of user groups which has permissions to the object. Nested schema for groups:
ObjectId This property is required. double
(Integer) Specifies the id of the object.
Tenants This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionTenant>
(List) Specifies a tenant object. Nested schema for tenant:
Users This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionUser>
(List) Specifies the list of users which has the permissions to the object. Nested schema for users:
Groups This property is required. []BackupRecoverySourceRegistrationSourceInfoPermissionGroup
(List) Specifies the list of user groups which has permissions to the object. Nested schema for groups:
ObjectId This property is required. float64
(Integer) Specifies the id of the object.
Tenants This property is required. []BackupRecoverySourceRegistrationSourceInfoPermissionTenant
(List) Specifies a tenant object. Nested schema for tenant:
Users This property is required. []BackupRecoverySourceRegistrationSourceInfoPermissionUser
(List) Specifies the list of users which has the permissions to the object. Nested schema for users:
groups This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionGroup>
(List) Specifies the list of user groups which has permissions to the object. Nested schema for groups:
objectId This property is required. Double
(Integer) Specifies the id of the object.
tenants This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionTenant>
(List) Specifies a tenant object. Nested schema for tenant:
users This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionUser>
(List) Specifies the list of users which has the permissions to the object. Nested schema for users:
groups This property is required. BackupRecoverySourceRegistrationSourceInfoPermissionGroup[]
(List) Specifies the list of user groups which has permissions to the object. Nested schema for groups:
objectId This property is required. number
(Integer) Specifies the id of the object.
tenants This property is required. BackupRecoverySourceRegistrationSourceInfoPermissionTenant[]
(List) Specifies a tenant object. Nested schema for tenant:
users This property is required. BackupRecoverySourceRegistrationSourceInfoPermissionUser[]
(List) Specifies the list of users which has the permissions to the object. Nested schema for users:
groups This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoPermissionGroup]
(List) Specifies the list of user groups which has permissions to the object. Nested schema for groups:
object_id This property is required. float
(Integer) Specifies the id of the object.
tenants This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoPermissionTenant]
(List) Specifies a tenant object. Nested schema for tenant:
users This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoPermissionUser]
(List) Specifies the list of users which has the permissions to the object. Nested schema for users:
groups This property is required. List<Property Map>
(List) Specifies the list of user groups which has permissions to the object. Nested schema for groups:
objectId This property is required. Number
(Integer) Specifies the id of the object.
tenants This property is required. List<Property Map>
(List) Specifies a tenant object. Nested schema for tenant:
users This property is required. List<Property Map>
(List) Specifies the list of users which has the permissions to the object. Nested schema for users:

BackupRecoverySourceRegistrationSourceInfoPermissionGroup
, BackupRecoverySourceRegistrationSourceInfoPermissionGroupArgs

Domain This property is required. string
(String) Specifies the domain of the user.
Name This property is required. string
The user specified name for this source.
Sid This property is required. string
(String) Specifies the sid of the user.
Domain This property is required. string
(String) Specifies the domain of the user.
Name This property is required. string
The user specified name for this source.
Sid This property is required. string
(String) Specifies the sid of the user.
domain This property is required. String
(String) Specifies the domain of the user.
name This property is required. String
The user specified name for this source.
sid This property is required. String
(String) Specifies the sid of the user.
domain This property is required. string
(String) Specifies the domain of the user.
name This property is required. string
The user specified name for this source.
sid This property is required. string
(String) Specifies the sid of the user.
domain This property is required. str
(String) Specifies the domain of the user.
name This property is required. str
The user specified name for this source.
sid This property is required. str
(String) Specifies the sid of the user.
domain This property is required. String
(String) Specifies the domain of the user.
name This property is required. String
The user specified name for this source.
sid This property is required. String
(String) Specifies the sid of the user.

BackupRecoverySourceRegistrationSourceInfoPermissionTenant
, BackupRecoverySourceRegistrationSourceInfoPermissionTenantArgs

CreatedAtTimeMsecs This property is required. double
(Integer) Epoch time when tenant was created.
DeletedAtTimeMsecs This property is required. double
(Integer) Epoch time when tenant was last updated.
Description This property is required. string
(String) Description about the tenant.
ExternalVendorMetadatas This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadata>
(List) Specifies the additional metadata for the tenant that is specifically set by the external vendors who are responsible for managing tenants. This field will only applicable if tenant creation is happening for a specially provisioned clusters for external vendors. Nested schema for external_vendor_metadata:
Id This property is required. string
(String) The tenant id.
IsManagedOnHelios This property is required. bool
(Boolean) Flag to indicate if tenant is managed on helios.
LastUpdatedAtTimeMsecs This property is required. double
(Integer) Epoch time when tenant was last updated.
Name This property is required. string
The user specified name for this source.
Networks This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionTenantNetwork>
(List) Networking information about a Tenant on a Cluster. Nested schema for network:
Status This property is required. string
(String) Current Status of the Tenant.

  • Constraints: Allowable values are: Active, Inactive, MarkedForDeletion, Deleted.
CreatedAtTimeMsecs This property is required. float64
(Integer) Epoch time when tenant was created.
DeletedAtTimeMsecs This property is required. float64
(Integer) Epoch time when tenant was last updated.
Description This property is required. string
(String) Description about the tenant.
ExternalVendorMetadatas This property is required. []BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadata
(List) Specifies the additional metadata for the tenant that is specifically set by the external vendors who are responsible for managing tenants. This field will only applicable if tenant creation is happening for a specially provisioned clusters for external vendors. Nested schema for external_vendor_metadata:
Id This property is required. string
(String) The tenant id.
IsManagedOnHelios This property is required. bool
(Boolean) Flag to indicate if tenant is managed on helios.
LastUpdatedAtTimeMsecs This property is required. float64
(Integer) Epoch time when tenant was last updated.
Name This property is required. string
The user specified name for this source.
Networks This property is required. []BackupRecoverySourceRegistrationSourceInfoPermissionTenantNetwork
(List) Networking information about a Tenant on a Cluster. Nested schema for network:
Status This property is required. string
(String) Current Status of the Tenant.

  • Constraints: Allowable values are: Active, Inactive, MarkedForDeletion, Deleted.
createdAtTimeMsecs This property is required. Double
(Integer) Epoch time when tenant was created.
deletedAtTimeMsecs This property is required. Double
(Integer) Epoch time when tenant was last updated.
description This property is required. String
(String) Description about the tenant.
externalVendorMetadatas This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadata>
(List) Specifies the additional metadata for the tenant that is specifically set by the external vendors who are responsible for managing tenants. This field will only applicable if tenant creation is happening for a specially provisioned clusters for external vendors. Nested schema for external_vendor_metadata:
id This property is required. String
(String) The tenant id.
isManagedOnHelios This property is required. Boolean
(Boolean) Flag to indicate if tenant is managed on helios.
lastUpdatedAtTimeMsecs This property is required. Double
(Integer) Epoch time when tenant was last updated.
name This property is required. String
The user specified name for this source.
networks This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionTenantNetwork>
(List) Networking information about a Tenant on a Cluster. Nested schema for network:
status This property is required. String
(String) Current Status of the Tenant.

  • Constraints: Allowable values are: Active, Inactive, MarkedForDeletion, Deleted.
createdAtTimeMsecs This property is required. number
(Integer) Epoch time when tenant was created.
deletedAtTimeMsecs This property is required. number
(Integer) Epoch time when tenant was last updated.
description This property is required. string
(String) Description about the tenant.
externalVendorMetadatas This property is required. BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadata[]
(List) Specifies the additional metadata for the tenant that is specifically set by the external vendors who are responsible for managing tenants. This field will only applicable if tenant creation is happening for a specially provisioned clusters for external vendors. Nested schema for external_vendor_metadata:
id This property is required. string
(String) The tenant id.
isManagedOnHelios This property is required. boolean
(Boolean) Flag to indicate if tenant is managed on helios.
lastUpdatedAtTimeMsecs This property is required. number
(Integer) Epoch time when tenant was last updated.
name This property is required. string
The user specified name for this source.
networks This property is required. BackupRecoverySourceRegistrationSourceInfoPermissionTenantNetwork[]
(List) Networking information about a Tenant on a Cluster. Nested schema for network:
status This property is required. string
(String) Current Status of the Tenant.

  • Constraints: Allowable values are: Active, Inactive, MarkedForDeletion, Deleted.
created_at_time_msecs This property is required. float
(Integer) Epoch time when tenant was created.
deleted_at_time_msecs This property is required. float
(Integer) Epoch time when tenant was last updated.
description This property is required. str
(String) Description about the tenant.
external_vendor_metadatas This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadata]
(List) Specifies the additional metadata for the tenant that is specifically set by the external vendors who are responsible for managing tenants. This field will only applicable if tenant creation is happening for a specially provisioned clusters for external vendors. Nested schema for external_vendor_metadata:
id This property is required. str
(String) The tenant id.
is_managed_on_helios This property is required. bool
(Boolean) Flag to indicate if tenant is managed on helios.
last_updated_at_time_msecs This property is required. float
(Integer) Epoch time when tenant was last updated.
name This property is required. str
The user specified name for this source.
networks This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoPermissionTenantNetwork]
(List) Networking information about a Tenant on a Cluster. Nested schema for network:
status This property is required. str
(String) Current Status of the Tenant.

  • Constraints: Allowable values are: Active, Inactive, MarkedForDeletion, Deleted.
createdAtTimeMsecs This property is required. Number
(Integer) Epoch time when tenant was created.
deletedAtTimeMsecs This property is required. Number
(Integer) Epoch time when tenant was last updated.
description This property is required. String
(String) Description about the tenant.
externalVendorMetadatas This property is required. List<Property Map>
(List) Specifies the additional metadata for the tenant that is specifically set by the external vendors who are responsible for managing tenants. This field will only applicable if tenant creation is happening for a specially provisioned clusters for external vendors. Nested schema for external_vendor_metadata:
id This property is required. String
(String) The tenant id.
isManagedOnHelios This property is required. Boolean
(Boolean) Flag to indicate if tenant is managed on helios.
lastUpdatedAtTimeMsecs This property is required. Number
(Integer) Epoch time when tenant was last updated.
name This property is required. String
The user specified name for this source.
networks This property is required. List<Property Map>
(List) Networking information about a Tenant on a Cluster. Nested schema for network:
status This property is required. String
(String) Current Status of the Tenant.

  • Constraints: Allowable values are: Active, Inactive, MarkedForDeletion, Deleted.

BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadata
, BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataArgs

IbmTenantMetadataParams This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParam>
(List) Specifies the additional metadata for the tenant that is specifically set by the external vendor of type 'IBM'. Nested schema for ibm_tenant_metadata_params:
Type This property is required. string
(String) Specifies the type of the external vendor. The type specific parameters must be specified the provided type.

  • Constraints: Allowable values are: IBM.
IbmTenantMetadataParams This property is required. []BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParam
(List) Specifies the additional metadata for the tenant that is specifically set by the external vendor of type 'IBM'. Nested schema for ibm_tenant_metadata_params:
Type This property is required. string
(String) Specifies the type of the external vendor. The type specific parameters must be specified the provided type.

  • Constraints: Allowable values are: IBM.
ibmTenantMetadataParams This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParam>
(List) Specifies the additional metadata for the tenant that is specifically set by the external vendor of type 'IBM'. Nested schema for ibm_tenant_metadata_params:
type This property is required. String
(String) Specifies the type of the external vendor. The type specific parameters must be specified the provided type.

  • Constraints: Allowable values are: IBM.
ibmTenantMetadataParams This property is required. BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParam[]
(List) Specifies the additional metadata for the tenant that is specifically set by the external vendor of type 'IBM'. Nested schema for ibm_tenant_metadata_params:
type This property is required. string
(String) Specifies the type of the external vendor. The type specific parameters must be specified the provided type.

  • Constraints: Allowable values are: IBM.
ibm_tenant_metadata_params This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParam]
(List) Specifies the additional metadata for the tenant that is specifically set by the external vendor of type 'IBM'. Nested schema for ibm_tenant_metadata_params:
type This property is required. str
(String) Specifies the type of the external vendor. The type specific parameters must be specified the provided type.

  • Constraints: Allowable values are: IBM.
ibmTenantMetadataParams This property is required. List<Property Map>
(List) Specifies the additional metadata for the tenant that is specifically set by the external vendor of type 'IBM'. Nested schema for ibm_tenant_metadata_params:
type This property is required. String
(String) Specifies the type of the external vendor. The type specific parameters must be specified the provided type.

  • Constraints: Allowable values are: IBM.

BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParam
, BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamArgs

AccountId This property is required. string
(String) Specifies the unique identifier of the IBM's account ID.
Crn This property is required. string
(String) Specifies the unique CRN associated with the tenant.
CustomProperties This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamCustomProperty>
(List) Specifies the list of custom properties associated with the tenant. External vendors can choose to set any properties inside following list. Note that the fields set inside the following will not be available for direct filtering. API callers should make sure that no sensitive information such as passwords is sent in these fields. Nested schema for custom_properties:
LivenessMode This property is required. string
(String) Specifies the current liveness mode of the tenant. This mode may change based on AZ failures when vendor chooses to failover or failback the tenants to other AZs.

  • Constraints: Allowable values are: Active, Standby.
MetricsConfigs This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfig>
(List) Specifies the metadata for metrics configuration. The metadata defined here will be used by cluster to send the usgae metrics to IBM cloud metering service for calculating the tenant billing. Nested schema for metrics_config:
OwnershipMode This property is required. string
(String) Specifies the current ownership mode for the tenant. The ownership of the tenant represents the active role for functioning of the tenant.

  • Constraints: Allowable values are: Primary, Secondary.
PlanId This property is required. string
(String) Specifies the Plan Id associated with the tenant. This field is introduced for tracking purposes inside IBM enviournment.
ResourceGroupId This property is required. string
(String) Specifies the Resource Group ID associated with the tenant.
ResourceInstanceId This property is required. string
(String) Specifies the Resource Instance ID associated with the tenant. This field is introduced for tracking purposes inside IBM enviournment.
AccountId This property is required. string
(String) Specifies the unique identifier of the IBM's account ID.
Crn This property is required. string
(String) Specifies the unique CRN associated with the tenant.
CustomProperties This property is required. []BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamCustomProperty
(List) Specifies the list of custom properties associated with the tenant. External vendors can choose to set any properties inside following list. Note that the fields set inside the following will not be available for direct filtering. API callers should make sure that no sensitive information such as passwords is sent in these fields. Nested schema for custom_properties:
LivenessMode This property is required. string
(String) Specifies the current liveness mode of the tenant. This mode may change based on AZ failures when vendor chooses to failover or failback the tenants to other AZs.

  • Constraints: Allowable values are: Active, Standby.
MetricsConfigs This property is required. []BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfig
(List) Specifies the metadata for metrics configuration. The metadata defined here will be used by cluster to send the usgae metrics to IBM cloud metering service for calculating the tenant billing. Nested schema for metrics_config:
OwnershipMode This property is required. string
(String) Specifies the current ownership mode for the tenant. The ownership of the tenant represents the active role for functioning of the tenant.

  • Constraints: Allowable values are: Primary, Secondary.
PlanId This property is required. string
(String) Specifies the Plan Id associated with the tenant. This field is introduced for tracking purposes inside IBM enviournment.
ResourceGroupId This property is required. string
(String) Specifies the Resource Group ID associated with the tenant.
ResourceInstanceId This property is required. string
(String) Specifies the Resource Instance ID associated with the tenant. This field is introduced for tracking purposes inside IBM enviournment.
accountId This property is required. String
(String) Specifies the unique identifier of the IBM's account ID.
crn This property is required. String
(String) Specifies the unique CRN associated with the tenant.
customProperties This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamCustomProperty>
(List) Specifies the list of custom properties associated with the tenant. External vendors can choose to set any properties inside following list. Note that the fields set inside the following will not be available for direct filtering. API callers should make sure that no sensitive information such as passwords is sent in these fields. Nested schema for custom_properties:
livenessMode This property is required. String
(String) Specifies the current liveness mode of the tenant. This mode may change based on AZ failures when vendor chooses to failover or failback the tenants to other AZs.

  • Constraints: Allowable values are: Active, Standby.
metricsConfigs This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfig>
(List) Specifies the metadata for metrics configuration. The metadata defined here will be used by cluster to send the usgae metrics to IBM cloud metering service for calculating the tenant billing. Nested schema for metrics_config:
ownershipMode This property is required. String
(String) Specifies the current ownership mode for the tenant. The ownership of the tenant represents the active role for functioning of the tenant.

  • Constraints: Allowable values are: Primary, Secondary.
planId This property is required. String
(String) Specifies the Plan Id associated with the tenant. This field is introduced for tracking purposes inside IBM enviournment.
resourceGroupId This property is required. String
(String) Specifies the Resource Group ID associated with the tenant.
resourceInstanceId This property is required. String
(String) Specifies the Resource Instance ID associated with the tenant. This field is introduced for tracking purposes inside IBM enviournment.
accountId This property is required. string
(String) Specifies the unique identifier of the IBM's account ID.
crn This property is required. string
(String) Specifies the unique CRN associated with the tenant.
customProperties This property is required. BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamCustomProperty[]
(List) Specifies the list of custom properties associated with the tenant. External vendors can choose to set any properties inside following list. Note that the fields set inside the following will not be available for direct filtering. API callers should make sure that no sensitive information such as passwords is sent in these fields. Nested schema for custom_properties:
livenessMode This property is required. string
(String) Specifies the current liveness mode of the tenant. This mode may change based on AZ failures when vendor chooses to failover or failback the tenants to other AZs.

  • Constraints: Allowable values are: Active, Standby.
metricsConfigs This property is required. BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfig[]
(List) Specifies the metadata for metrics configuration. The metadata defined here will be used by cluster to send the usgae metrics to IBM cloud metering service for calculating the tenant billing. Nested schema for metrics_config:
ownershipMode This property is required. string
(String) Specifies the current ownership mode for the tenant. The ownership of the tenant represents the active role for functioning of the tenant.

  • Constraints: Allowable values are: Primary, Secondary.
planId This property is required. string
(String) Specifies the Plan Id associated with the tenant. This field is introduced for tracking purposes inside IBM enviournment.
resourceGroupId This property is required. string
(String) Specifies the Resource Group ID associated with the tenant.
resourceInstanceId This property is required. string
(String) Specifies the Resource Instance ID associated with the tenant. This field is introduced for tracking purposes inside IBM enviournment.
account_id This property is required. str
(String) Specifies the unique identifier of the IBM's account ID.
crn This property is required. str
(String) Specifies the unique CRN associated with the tenant.
custom_properties This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamCustomProperty]
(List) Specifies the list of custom properties associated with the tenant. External vendors can choose to set any properties inside following list. Note that the fields set inside the following will not be available for direct filtering. API callers should make sure that no sensitive information such as passwords is sent in these fields. Nested schema for custom_properties:
liveness_mode This property is required. str
(String) Specifies the current liveness mode of the tenant. This mode may change based on AZ failures when vendor chooses to failover or failback the tenants to other AZs.

  • Constraints: Allowable values are: Active, Standby.
metrics_configs This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfig]
(List) Specifies the metadata for metrics configuration. The metadata defined here will be used by cluster to send the usgae metrics to IBM cloud metering service for calculating the tenant billing. Nested schema for metrics_config:
ownership_mode This property is required. str
(String) Specifies the current ownership mode for the tenant. The ownership of the tenant represents the active role for functioning of the tenant.

  • Constraints: Allowable values are: Primary, Secondary.
plan_id This property is required. str
(String) Specifies the Plan Id associated with the tenant. This field is introduced for tracking purposes inside IBM enviournment.
resource_group_id This property is required. str
(String) Specifies the Resource Group ID associated with the tenant.
resource_instance_id This property is required. str
(String) Specifies the Resource Instance ID associated with the tenant. This field is introduced for tracking purposes inside IBM enviournment.
accountId This property is required. String
(String) Specifies the unique identifier of the IBM's account ID.
crn This property is required. String
(String) Specifies the unique CRN associated with the tenant.
customProperties This property is required. List<Property Map>
(List) Specifies the list of custom properties associated with the tenant. External vendors can choose to set any properties inside following list. Note that the fields set inside the following will not be available for direct filtering. API callers should make sure that no sensitive information such as passwords is sent in these fields. Nested schema for custom_properties:
livenessMode This property is required. String
(String) Specifies the current liveness mode of the tenant. This mode may change based on AZ failures when vendor chooses to failover or failback the tenants to other AZs.

  • Constraints: Allowable values are: Active, Standby.
metricsConfigs This property is required. List<Property Map>
(List) Specifies the metadata for metrics configuration. The metadata defined here will be used by cluster to send the usgae metrics to IBM cloud metering service for calculating the tenant billing. Nested schema for metrics_config:
ownershipMode This property is required. String
(String) Specifies the current ownership mode for the tenant. The ownership of the tenant represents the active role for functioning of the tenant.

  • Constraints: Allowable values are: Primary, Secondary.
planId This property is required. String
(String) Specifies the Plan Id associated with the tenant. This field is introduced for tracking purposes inside IBM enviournment.
resourceGroupId This property is required. String
(String) Specifies the Resource Group ID associated with the tenant.
resourceInstanceId This property is required. String
(String) Specifies the Resource Instance ID associated with the tenant. This field is introduced for tracking purposes inside IBM enviournment.

BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamCustomProperty
, BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamCustomPropertyArgs

Key This property is required. string
(String) Specifies the unique key for custom property.
Value This property is required. string
(String) Specifies the value for the above custom key.
Key This property is required. string
(String) Specifies the unique key for custom property.
Value This property is required. string
(String) Specifies the value for the above custom key.
key This property is required. String
(String) Specifies the unique key for custom property.
value This property is required. String
(String) Specifies the value for the above custom key.
key This property is required. string
(String) Specifies the unique key for custom property.
value This property is required. string
(String) Specifies the value for the above custom key.
key This property is required. str
(String) Specifies the unique key for custom property.
value This property is required. str
(String) Specifies the value for the above custom key.
key This property is required. String
(String) Specifies the unique key for custom property.
value This property is required. String
(String) Specifies the value for the above custom key.

BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfig
, BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigArgs

CosResourceConfigs This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigCosResourceConfig>
(List) Specifies the details of COS resource configuration required for posting metrics and trackinb billing information for IBM tenants. Nested schema for cos_resource_config:
IamMetricsConfigs This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigIamMetricsConfig>
(List) Specifies the IAM configuration that will be used for accessing the billing service in IBM cloud. Nested schema for iam_metrics_config:
MeteringConfigs This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigMeteringConfig>
(List) Specifies the metering configuration that will be used for IBM cluster to send the billing details to IBM billing service. Nested schema for metering_config:
CosResourceConfigs This property is required. []BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigCosResourceConfig
(List) Specifies the details of COS resource configuration required for posting metrics and trackinb billing information for IBM tenants. Nested schema for cos_resource_config:
IamMetricsConfigs This property is required. []BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigIamMetricsConfig
(List) Specifies the IAM configuration that will be used for accessing the billing service in IBM cloud. Nested schema for iam_metrics_config:
MeteringConfigs This property is required. []BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigMeteringConfig
(List) Specifies the metering configuration that will be used for IBM cluster to send the billing details to IBM billing service. Nested schema for metering_config:
cosResourceConfigs This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigCosResourceConfig>
(List) Specifies the details of COS resource configuration required for posting metrics and trackinb billing information for IBM tenants. Nested schema for cos_resource_config:
iamMetricsConfigs This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigIamMetricsConfig>
(List) Specifies the IAM configuration that will be used for accessing the billing service in IBM cloud. Nested schema for iam_metrics_config:
meteringConfigs This property is required. List<BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigMeteringConfig>
(List) Specifies the metering configuration that will be used for IBM cluster to send the billing details to IBM billing service. Nested schema for metering_config:
cosResourceConfigs This property is required. BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigCosResourceConfig[]
(List) Specifies the details of COS resource configuration required for posting metrics and trackinb billing information for IBM tenants. Nested schema for cos_resource_config:
iamMetricsConfigs This property is required. BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigIamMetricsConfig[]
(List) Specifies the IAM configuration that will be used for accessing the billing service in IBM cloud. Nested schema for iam_metrics_config:
meteringConfigs This property is required. BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigMeteringConfig[]
(List) Specifies the metering configuration that will be used for IBM cluster to send the billing details to IBM billing service. Nested schema for metering_config:
cos_resource_configs This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigCosResourceConfig]
(List) Specifies the details of COS resource configuration required for posting metrics and trackinb billing information for IBM tenants. Nested schema for cos_resource_config:
iam_metrics_configs This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigIamMetricsConfig]
(List) Specifies the IAM configuration that will be used for accessing the billing service in IBM cloud. Nested schema for iam_metrics_config:
metering_configs This property is required. Sequence[BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigMeteringConfig]
(List) Specifies the metering configuration that will be used for IBM cluster to send the billing details to IBM billing service. Nested schema for metering_config:
cosResourceConfigs This property is required. List<Property Map>
(List) Specifies the details of COS resource configuration required for posting metrics and trackinb billing information for IBM tenants. Nested schema for cos_resource_config:
iamMetricsConfigs This property is required. List<Property Map>
(List) Specifies the IAM configuration that will be used for accessing the billing service in IBM cloud. Nested schema for iam_metrics_config:
meteringConfigs This property is required. List<Property Map>
(List) Specifies the metering configuration that will be used for IBM cluster to send the billing details to IBM billing service. Nested schema for metering_config:

BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigCosResourceConfig
, BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigCosResourceConfigArgs

ResourceUrl This property is required. string
(String) Specifies the resource COS resource configuration endpoint that will be used for fetching bucket usage for a given tenant.
ResourceUrl This property is required. string
(String) Specifies the resource COS resource configuration endpoint that will be used for fetching bucket usage for a given tenant.
resourceUrl This property is required. String
(String) Specifies the resource COS resource configuration endpoint that will be used for fetching bucket usage for a given tenant.
resourceUrl This property is required. string
(String) Specifies the resource COS resource configuration endpoint that will be used for fetching bucket usage for a given tenant.
resource_url This property is required. str
(String) Specifies the resource COS resource configuration endpoint that will be used for fetching bucket usage for a given tenant.
resourceUrl This property is required. String
(String) Specifies the resource COS resource configuration endpoint that will be used for fetching bucket usage for a given tenant.

BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigIamMetricsConfig
, BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigIamMetricsConfigArgs

BillingApiKeySecretId This property is required. string
(String) Specifies Id of the secret that contains the API key.
IamUrl This property is required. string
(String) Specifies the IAM URL needed to fetch the operator token from IBM. The operator token is needed to make service API calls to IBM billing service.
BillingApiKeySecretId This property is required. string
(String) Specifies Id of the secret that contains the API key.
IamUrl This property is required. string
(String) Specifies the IAM URL needed to fetch the operator token from IBM. The operator token is needed to make service API calls to IBM billing service.
billingApiKeySecretId This property is required. String
(String) Specifies Id of the secret that contains the API key.
iamUrl This property is required. String
(String) Specifies the IAM URL needed to fetch the operator token from IBM. The operator token is needed to make service API calls to IBM billing service.
billingApiKeySecretId This property is required. string
(String) Specifies Id of the secret that contains the API key.
iamUrl This property is required. string
(String) Specifies the IAM URL needed to fetch the operator token from IBM. The operator token is needed to make service API calls to IBM billing service.
billing_api_key_secret_id This property is required. str
(String) Specifies Id of the secret that contains the API key.
iam_url This property is required. str
(String) Specifies the IAM URL needed to fetch the operator token from IBM. The operator token is needed to make service API calls to IBM billing service.
billingApiKeySecretId This property is required. String
(String) Specifies Id of the secret that contains the API key.
iamUrl This property is required. String
(String) Specifies the IAM URL needed to fetch the operator token from IBM. The operator token is needed to make service API calls to IBM billing service.

BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigMeteringConfig
, BackupRecoverySourceRegistrationSourceInfoPermissionTenantExternalVendorMetadataIbmTenantMetadataParamMetricsConfigMeteringConfigArgs

PartIds This property is required. List<string>
(List) Specifies the list of part identifiers used for metrics identification.

  • Constraints: Allowable list items are: USAGETERABYTE. The minimum length is 1 item.
SubmissionIntervalInSecs This property is required. double
(Integer) Specifies the frequency in seconds at which the metrics will be pushed to IBM billing service from cluster.
Url This property is required. string
(String) Specifies the base metering URL that will be used by cluster to send the billing information.
PartIds This property is required. []string
(List) Specifies the list of part identifiers used for metrics identification.

  • Constraints: Allowable list items are: USAGETERABYTE. The minimum length is 1 item.
SubmissionIntervalInSecs This property is required. float64
(Integer) Specifies the frequency in seconds at which the metrics will be pushed to IBM billing service from cluster.
Url This property is required. string
(String) Specifies the base metering URL that will be used by cluster to send the billing information.
partIds This property is required. List<String>
(List) Specifies the list of part identifiers used for metrics identification.

  • Constraints: Allowable list items are: USAGETERABYTE. The minimum length is 1 item.
submissionIntervalInSecs This property is required. Double
(Integer) Specifies the frequency in seconds at which the metrics will be pushed to IBM billing service from cluster.
url This property is required. String
(String) Specifies the base metering URL that will be used by cluster to send the billing information.
partIds This property is required. string[]
(List) Specifies the list of part identifiers used for metrics identification.

  • Constraints: Allowable list items are: USAGETERABYTE. The minimum length is 1 item.
submissionIntervalInSecs This property is required. number
(Integer) Specifies the frequency in seconds at which the metrics will be pushed to IBM billing service from cluster.
url This property is required. string
(String) Specifies the base metering URL that will be used by cluster to send the billing information.
part_ids This property is required. Sequence[str]
(List) Specifies the list of part identifiers used for metrics identification.

  • Constraints: Allowable list items are: USAGETERABYTE. The minimum length is 1 item.
submission_interval_in_secs This property is required. float
(Integer) Specifies the frequency in seconds at which the metrics will be pushed to IBM billing service from cluster.
url This property is required. str
(String) Specifies the base metering URL that will be used by cluster to send the billing information.
partIds This property is required. List<String>
(List) Specifies the list of part identifiers used for metrics identification.

  • Constraints: Allowable list items are: USAGETERABYTE. The minimum length is 1 item.
submissionIntervalInSecs This property is required. Number
(Integer) Specifies the frequency in seconds at which the metrics will be pushed to IBM billing service from cluster.
url This property is required. String
(String) Specifies the base metering URL that will be used by cluster to send the billing information.

BackupRecoverySourceRegistrationSourceInfoPermissionTenantNetwork
, BackupRecoverySourceRegistrationSourceInfoPermissionTenantNetworkArgs

ClusterHostname This property is required. string
(String) The hostname for Cohesity cluster as seen by tenants and as is routable from the tenant's network. Tenant's VLAN's hostname, if available can be used instead but it is mandatory to provide this value if there's no VLAN hostname to use. Also, when set, this field would take precedence over VLAN hostname.
ClusterIps This property is required. List<string>
(List) Set of IPs as seen from the tenant's network for the Cohesity cluster. Only one from 'clusterHostname' and 'clusterIps' is needed.
ConnectorEnabled This property is required. bool
(Boolean) Whether connector (hybrid extender) is enabled.
ClusterHostname This property is required. string
(String) The hostname for Cohesity cluster as seen by tenants and as is routable from the tenant's network. Tenant's VLAN's hostname, if available can be used instead but it is mandatory to provide this value if there's no VLAN hostname to use. Also, when set, this field would take precedence over VLAN hostname.
ClusterIps This property is required. []string
(List) Set of IPs as seen from the tenant's network for the Cohesity cluster. Only one from 'clusterHostname' and 'clusterIps' is needed.
ConnectorEnabled This property is required. bool
(Boolean) Whether connector (hybrid extender) is enabled.
clusterHostname This property is required. String
(String) The hostname for Cohesity cluster as seen by tenants and as is routable from the tenant's network. Tenant's VLAN's hostname, if available can be used instead but it is mandatory to provide this value if there's no VLAN hostname to use. Also, when set, this field would take precedence over VLAN hostname.
clusterIps This property is required. List<String>
(List) Set of IPs as seen from the tenant's network for the Cohesity cluster. Only one from 'clusterHostname' and 'clusterIps' is needed.
connectorEnabled This property is required. Boolean
(Boolean) Whether connector (hybrid extender) is enabled.
clusterHostname This property is required. string
(String) The hostname for Cohesity cluster as seen by tenants and as is routable from the tenant's network. Tenant's VLAN's hostname, if available can be used instead but it is mandatory to provide this value if there's no VLAN hostname to use. Also, when set, this field would take precedence over VLAN hostname.
clusterIps This property is required. string[]
(List) Set of IPs as seen from the tenant's network for the Cohesity cluster. Only one from 'clusterHostname' and 'clusterIps' is needed.
connectorEnabled This property is required. boolean
(Boolean) Whether connector (hybrid extender) is enabled.
cluster_hostname This property is required. str
(String) The hostname for Cohesity cluster as seen by tenants and as is routable from the tenant's network. Tenant's VLAN's hostname, if available can be used instead but it is mandatory to provide this value if there's no VLAN hostname to use. Also, when set, this field would take precedence over VLAN hostname.
cluster_ips This property is required. Sequence[str]
(List) Set of IPs as seen from the tenant's network for the Cohesity cluster. Only one from 'clusterHostname' and 'clusterIps' is needed.
connector_enabled This property is required. bool
(Boolean) Whether connector (hybrid extender) is enabled.
clusterHostname This property is required. String
(String) The hostname for Cohesity cluster as seen by tenants and as is routable from the tenant's network. Tenant's VLAN's hostname, if available can be used instead but it is mandatory to provide this value if there's no VLAN hostname to use. Also, when set, this field would take precedence over VLAN hostname.
clusterIps This property is required. List<String>
(List) Set of IPs as seen from the tenant's network for the Cohesity cluster. Only one from 'clusterHostname' and 'clusterIps' is needed.
connectorEnabled This property is required. Boolean
(Boolean) Whether connector (hybrid extender) is enabled.

BackupRecoverySourceRegistrationSourceInfoPermissionUser
, BackupRecoverySourceRegistrationSourceInfoPermissionUserArgs

Domain This property is required. string
(String) Specifies the domain of the user.
Name This property is required. string
The user specified name for this source.
Sid This property is required. string
(String) Specifies the sid of the user.
Domain This property is required. string
(String) Specifies the domain of the user.
Name This property is required. string
The user specified name for this source.
Sid This property is required. string
(String) Specifies the sid of the user.
domain This property is required. String
(String) Specifies the domain of the user.
name This property is required. String
The user specified name for this source.
sid This property is required. String
(String) Specifies the sid of the user.
domain This property is required. string
(String) Specifies the domain of the user.
name This property is required. string
The user specified name for this source.
sid This property is required. string
(String) Specifies the sid of the user.
domain This property is required. str
(String) Specifies the domain of the user.
name This property is required. str
The user specified name for this source.
sid This property is required. str
(String) Specifies the sid of the user.
domain This property is required. String
(String) Specifies the domain of the user.
name This property is required. String
The user specified name for this source.
sid This property is required. String
(String) Specifies the sid of the user.

BackupRecoverySourceRegistrationSourceInfoPhysicalParam
, BackupRecoverySourceRegistrationSourceInfoPhysicalParamArgs

EnableSystemBackup This property is required. bool
(Boolean) Specifies if system backup was enabled for the source in a particular run.
EnableSystemBackup This property is required. bool
(Boolean) Specifies if system backup was enabled for the source in a particular run.
enableSystemBackup This property is required. Boolean
(Boolean) Specifies if system backup was enabled for the source in a particular run.
enableSystemBackup This property is required. boolean
(Boolean) Specifies if system backup was enabled for the source in a particular run.
enable_system_backup This property is required. bool
(Boolean) Specifies if system backup was enabled for the source in a particular run.
enableSystemBackup This property is required. Boolean
(Boolean) Specifies if system backup was enabled for the source in a particular run.

BackupRecoverySourceRegistrationSourceInfoProtectionStat
, BackupRecoverySourceRegistrationSourceInfoProtectionStatArgs

DeletedProtectedCount This property is required. double
(Integer) Specifies the count of protected leaf objects which were deleted from the source after being protected.
Environment This property is required. string
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
ProtectedCount This property is required. double
(Integer) Specifies the count of the protected leaf objects.
ProtectedSizeBytes This property is required. double
(Integer) Specifies the protected logical size in bytes.
UnprotectedCount This property is required. double
(Integer) Specifies the count of the unprotected leaf objects.
UnprotectedSizeBytes This property is required. double
(Integer) Specifies the unprotected logical size in bytes.
DeletedProtectedCount This property is required. float64
(Integer) Specifies the count of protected leaf objects which were deleted from the source after being protected.
Environment This property is required. string
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
ProtectedCount This property is required. float64
(Integer) Specifies the count of the protected leaf objects.
ProtectedSizeBytes This property is required. float64
(Integer) Specifies the protected logical size in bytes.
UnprotectedCount This property is required. float64
(Integer) Specifies the count of the unprotected leaf objects.
UnprotectedSizeBytes This property is required. float64
(Integer) Specifies the unprotected logical size in bytes.
deletedProtectedCount This property is required. Double
(Integer) Specifies the count of protected leaf objects which were deleted from the source after being protected.
environment This property is required. String
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
protectedCount This property is required. Double
(Integer) Specifies the count of the protected leaf objects.
protectedSizeBytes This property is required. Double
(Integer) Specifies the protected logical size in bytes.
unprotectedCount This property is required. Double
(Integer) Specifies the count of the unprotected leaf objects.
unprotectedSizeBytes This property is required. Double
(Integer) Specifies the unprotected logical size in bytes.
deletedProtectedCount This property is required. number
(Integer) Specifies the count of protected leaf objects which were deleted from the source after being protected.
environment This property is required. string
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
protectedCount This property is required. number
(Integer) Specifies the count of the protected leaf objects.
protectedSizeBytes This property is required. number
(Integer) Specifies the protected logical size in bytes.
unprotectedCount This property is required. number
(Integer) Specifies the count of the unprotected leaf objects.
unprotectedSizeBytes This property is required. number
(Integer) Specifies the unprotected logical size in bytes.
deleted_protected_count This property is required. float
(Integer) Specifies the count of protected leaf objects which were deleted from the source after being protected.
environment This property is required. str
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
protected_count This property is required. float
(Integer) Specifies the count of the protected leaf objects.
protected_size_bytes This property is required. float
(Integer) Specifies the protected logical size in bytes.
unprotected_count This property is required. float
(Integer) Specifies the count of the unprotected leaf objects.
unprotected_size_bytes This property is required. float
(Integer) Specifies the unprotected logical size in bytes.
deletedProtectedCount This property is required. Number
(Integer) Specifies the count of protected leaf objects which were deleted from the source after being protected.
environment This property is required. String
Specifies the environment type of the Protection Source.

  • Constraints: Allowable values are: kPhysical, kSQL.
protectedCount This property is required. Number
(Integer) Specifies the count of the protected leaf objects.
protectedSizeBytes This property is required. Number
(Integer) Specifies the protected logical size in bytes.
unprotectedCount This property is required. Number
(Integer) Specifies the count of the unprotected leaf objects.
unprotectedSizeBytes This property is required. Number
(Integer) Specifies the unprotected logical size in bytes.

BackupRecoverySourceRegistrationSourceInfoSharepointSiteSummary
, BackupRecoverySourceRegistrationSourceInfoSharepointSiteSummaryArgs

SiteWebUrl This property is required. string
(String) Specifies the web url for the Sharepoint site.
SiteWebUrl This property is required. string
(String) Specifies the web url for the Sharepoint site.
siteWebUrl This property is required. String
(String) Specifies the web url for the Sharepoint site.
siteWebUrl This property is required. string
(String) Specifies the web url for the Sharepoint site.
site_web_url This property is required. str
(String) Specifies the web url for the Sharepoint site.
siteWebUrl This property is required. String
(String) Specifies the web url for the Sharepoint site.

BackupRecoverySourceRegistrationSourceInfoVCenterSummary
, BackupRecoverySourceRegistrationSourceInfoVCenterSummaryArgs

IsCloudEnv This property is required. bool
(Boolean) Specifies that registered vCenter source is a VMC (VMware Cloud) environment or not.
IsCloudEnv This property is required. bool
(Boolean) Specifies that registered vCenter source is a VMC (VMware Cloud) environment or not.
isCloudEnv This property is required. Boolean
(Boolean) Specifies that registered vCenter source is a VMC (VMware Cloud) environment or not.
isCloudEnv This property is required. boolean
(Boolean) Specifies that registered vCenter source is a VMC (VMware Cloud) environment or not.
is_cloud_env This property is required. bool
(Boolean) Specifies that registered vCenter source is a VMC (VMware Cloud) environment or not.
isCloudEnv This property is required. Boolean
(Boolean) Specifies that registered vCenter source is a VMC (VMware Cloud) environment or not.

BackupRecoverySourceRegistrationSourceInfoWindowsClusterSummary
, BackupRecoverySourceRegistrationSourceInfoWindowsClusterSummaryArgs

ClusterSourceType This property is required. string
(String) Specifies the type of cluster resource this source represents.
ClusterSourceType This property is required. string
(String) Specifies the type of cluster resource this source represents.
clusterSourceType This property is required. String
(String) Specifies the type of cluster resource this source represents.
clusterSourceType This property is required. string
(String) Specifies the type of cluster resource this source represents.
cluster_source_type This property is required. str
(String) Specifies the type of cluster resource this source represents.
clusterSourceType This property is required. String
(String) Specifies the type of cluster resource this source represents.

Import

You can import the ibm_backup_recovery_source_registration resource by using id. Source Registration ID. The ID is formed using tenantID and resourceId.

id = <tenantId>::<source_id>.

Syntax

import {

to = <ibm_backup_recovery_resource>

id = "<tenantId>::<source_id>"

}

Example

resource “ibm_backup_recovery_source_registration” “terra_source_registration_2” {

x_ibm_tenant_id = “jhxqx715r9/”

environment = “kPhysical”

connection_id = “6456”

physical_params {

endpoint = "172.26.1.1"

host_type = "kLinux"

physical_type = "kHost"

}

}

import {

to = ibm_backup_recovery_source_registration.terra_source_registration_1

id = "jhxqx715r9/::3"

}

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.