models.register_protection_source_parameters module

class models.register_protection_source_parameters.RegisterProtectionSourceParameters(acropolis_type=None, agent_endpoint=None, aws_credentials=None, aws_fleet_params=None, azure_credentials=None, blacklisted_ip_addresses=None, cluster_network_info=None, endpoint=None, environment=None, exchange_dag_protection_preference=None, force_register=None, gcp_credentials=None, host_type=None, hyperv_type=None, kubernetes_credentials=None, kubernetes_type=None, kvm_type=None, nas_mount_credentials=None, netapp_type=None, nimble_type=None, office365_credentials_list=None, office_365_region=None, office_365_type=None, password=None, physical_type=None, pure_type=None, re_register=None, source_side_dedup_enabled=None, ssl_verification=None, subnets=None, throttling_policy=None, throttling_policy_overrides=None, use_o_auth_for_exchange_online=None, username=None, vlan_params=None, vmware_params=None, vmware_type=None)

Bases: object

Implementation of the ‘RegisterProtectionSourceParameters’ model.

Specifies the parameters required to register a Protection Source.

Attributes:

acropolis_type (AcropolisTypeEnum): Specifies the entity type if the

environment is kAcropolis. overrideDescription: true

agent_endpoint (string): Specifies the agent endpoint if it is

different from the source endpoint.

aws_credentials (AwsCredentials): Specifies the credentials to

authenticate with AWS Cloud Platform.

aws_fleet_params (AwsFleetParams): Specifies information related to

AWS fleets launched for various purposes. This will only be set for kIAMUser entity.

azure_credentials (AzureCredentials): Specifies the credentials to

authenticate with Azure Cloud Platform.

blacklisted_ip_addresses (list of string): This field is deprecated.

Use DeniedIpAddresses instead. deprecated: true

cluster_network_info (FleetNetworkParams): Specifies information

related to cluster. This is only valid for CE clusters. This is only populated for kIAMUser entity.

endpoint (string): Specifies the network endpoint of the Protection

Source where it is reachable. It could be an URL or hostname or an IP address of the Protection Source.

environment (EnvironmentRegisterProtectionSourceParametersEnum):

Specifies the environment such as ‘kPhysical’ or ‘kVMware’ of the Protection Source. overrideDescription: true Supported environment types such as ‘kView’, ‘kSQL’, ‘kVMware’, etc. NOTE: ‘kPuppeteer’ refers to Cohesity’s Remote Adapter. ‘kVMware’ indicates the VMware Protection Source environment. ‘kHyperV’ indicates the HyperV Protection Source environment. ‘kSQL’ indicates the SQL Protection Source environment. ‘kView’ indicates the View Protection Source environment. ‘kPuppeteer’ indicates the Cohesity’s Remote Adapter. ‘kPhysical’ indicates the physical Protection Source environment. ‘kPure’ indicates the Pure Storage Protection Source environment. ‘Nimble’ indicates the Nimble Storage Protection Source environment. ‘kAzure’ indicates the Microsoft’s Azure Protection Source environment. ‘kNetapp’ indicates the Netapp Protection Source environment. ‘kAgent’ indicates the Agent Protection Source environment. ‘kGenericNas’ indicates the Generic Network Attached Storage Protection Source environment. ‘kAcropolis’ indicates the Acropolis Protection Source environment. ‘kPhsicalFiles’ indicates the Physical Files Protection Source environment. ‘kIsilon’ indicates the Dell EMC’s Isilon Protection Source environment. ‘kGPFS’ indicates IBM’s GPFS Protection Source environment. ‘kKVM’ indicates the KVM Protection Source environment. ‘kAWS’ indicates the AWS Protection Source environment. ‘kExchange’ indicates the Exchange Protection Source environment. ‘kHyperVVSS’ indicates the HyperV VSS Protection Source environment. ‘kOracle’ indicates the Oracle Protection Source environment. ‘kGCP’ indicates the Google Cloud Platform Protection Source environment. ‘kFlashBlade’ indicates the Flash Blade Protection Source environment. ‘kAWSNative’ indicates the AWS Native Protection Source environment. ‘kO365’ indicates the Office 365 Protection Source environment. ‘kO365Outlook’ indicates Office 365 outlook Protection Source environment. ‘kHyperFlex’ indicates the Hyper Flex Protection Source environment. ‘kGCPNative’ indicates the GCP Native Protection Source environment. ‘kAzureNative’ indicates the Azure Native Protection Source environment. ‘kKubernetes’ indicates a Kubernetes Protection Source environment. ‘kElastifile’ indicates Elastifile Protection Source environment. ‘kAD’ indicates Active Directory Protection Source environment. ‘kRDSSnapshotManager’ indicates AWS RDS Protection Source environment. ‘kCassandra’ indicates Cassandra Protection Source environment. ‘kMongoDB’ indicates MongoDB Protection Source environment. ‘kCouchbase’ indicates Couchbase Protection Source environment. ‘kHdfs’ indicates Hdfs Protection Source environment. ‘kHive’ indicates Hive Protection Source environment. ‘kHBase’ indicates HBase Protection Source environment.

exchange_dag_protection_preference (ExchangeDAGProtectionPreference):

Specifies information about the preference order while choosing between which database copy of the exchange database which is part of DAG should be protected.

force_register (bool): ForceRegister is applicable to Physical

Environment. By default, 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. This is a hidden parameter and should not be documented externally.

gcp_credentials (GcpCredentials): Specifies the credentials to

authenticate with Google Cloud Platform.

host_type (HostTypeRegisterProtectionSourceParametersEnum): Specifies

the optional OS type of the Protection Source (such as kWindows or kLinux). overrideDescription: true ‘kLinux’ indicates the Linux operating system. ‘kWindows’ indicates the Microsoft Windows operating system. ‘kAix’ indicates the IBM AIX operating system. ‘kSolaris’ indicates the Oracle Solaris operating system. ‘kSapHana’ indicates the Sap Hana database system developed by SAP SE. ‘kOther’ indicates the other types of operating system.

hyperv_type (HypervTypeEnum): Specifies the entity type if the

environment is kHyperV. overrideDescription: true

kubernetes_credentials (KubernetesCredentials): Specifies the

credentials to authenticate with a Kubernetes Cluster.

kubernetes_type (KubernetesTypeEnum): Specifies the entity type if the

environment is kKubernetes. overrideDescription: true

kvm_type (KvmTypeEnum): Specifies the entity type if the environment

is kKVM. overrideDescription: true

nas_mount_credentials (NasMountCredentialParams): Specifies the server

credentials to connect to a NetApp server. This field is required for mounting SMB volumes on NetApp servers.

netapp_type (NetappTypeEnum): Specifies the entity type such as

‘kCluster,’ if the environment is kNetapp.

nimble_type (NimbleTypeEnum): Specifies the entity type such as

‘kStorageArray’ if the environment is kNimble.

office365_credentials_list (list of Office365Credentials): Office365 Source

Credentials.

Specifies credentials needed to authenticate & authorize user for Office365 using MS Graph APIs.

office_365_region (string): Specifies the region for Office365. office_365_type (Office365TypeEnum): Specifies the entity type such as

‘kDomain’, ‘kOutlook’, ‘kMailbox’, if the environment is kO365.

password (string): Specifies password of the username to access the

target source.

physical_type (PhysicalTypeEnum): Specifies the entity type such as

‘kPhysicalHost’ if the environment is kPhysical. overrideDescription: true

pure_type (PureTypeEnum): Specifies the entity type such as

‘kStorageArray’ if the environment is kPure.

re_register (bool): ReRegister is applicable to Physical Environment.

By default, the agent running on a physical host will fail the registration, if it is already registered with the cluster. By setting this option to true, agent can be re-registered with the current cluster.

source_side_dedup_enabled (bool): This controls whether to use source

side dedup on the source or not. This is only applicable to sources which support source side dedup (e.g., Linux physical servers).

ssl_verification (SslVerification): SSL verification parameter is

applicable to VMware environment. It can be populated with the server’s CA certificate or certificate chain and vCenter’s certificate will be validated against this.

subnets (list of Subnet): Specifies the list of subnet IP addresses

and CIDR prefix for enabeling network data transfer. Currently, only Subnet IP and NetbaskBits are valid input fields. All other fields provided as input will be ignored.

throttling_policy (ThrottlingPolicyParameters): Specifies the

throttling policy that should be applied to this Source.

throttling_policy_overrides (list of ThrottlingPolicyOverride): Array

of Throttling Policy Overrides for Datastores. Specifies a list of Throttling Policy for datastores that override the common throttling policy specified for the registered Protection Source. For datastores not in this list, common policy will still apply.

use_o_auth_for_exchange_online (bool): Specifies whether OAuth should

be used for authentication in case of Exchange Online.

username (string): Specifies username to access the target source. vlan_params (VlanParameters): Specifies the VLAN parameters to be used

while taking the backup of this entity and is the preferred selection for restoring the same. For restores, the VLAN parameters specifed here can be overridden. Currently, this is only applicable for Physical hosts running Oracle.

vmware_params (VmwareParams): Contains all params specified by the

user while registering a Vmware entity.

vmware_type (VmwareTypeEnum): Specifies the entity type such as

‘kVCenter’ if the environment is kVMware. overrideDescription: true

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.