models.registered_source_info module

class models.registered_source_info.RegisteredSourceInfo(access_info=None, authentication_error_message=None, authentication_status=None, blacklisted_ip_addresses=None, cassandra_params=None, couchbase_params=None, environments=None, hbase_params=None, hdfs_params=None, hive_params=None, is_db_authenticated=None, minimum_free_space_gb=None, mongodb_params=None, nas_mount_credentials=None, office_365_credentials_list=None, office_365_region=None, password=None, refresh_error_message=None, refresh_time_usecs=None, registered_apps_info=None, registration_time_usecs=None, subnets=None, throttling_policy=None, throttling_policy_overrides=None, use_o_auth_for_exchange_online=None, use_vm_bios_uuid=None, username=None, vlan_params=None, warning_messages=None)

Bases: object

Implementation of the ‘RegisteredSourceInfo’ model.

Specifies information about a registered Source.

Attributes:

access_info (ConnectorParameters): Specifies the parameters required

to establish a connection with a particular environment.

authentication_error_message (string): Specifies an authentication

error message. This indicates the given credentials are rejected and the registration of the source is not successful.

authentication_status (AuthenticationStatusEnum): Specifies the status

of the authenticating to the Protection Source when registering it with Cohesity Cluster. If the status is ‘kFinished’ and there is no error, registration is successful. Specifies the status of the authentication during the registration of a Protection Source. ‘kPending’ indicates the authentication is in progress. ‘kScheduled’ indicates the authentication is scheduled. ‘kFinished’ indicates the authentication is completed. ‘kRefreshInProgress’ indicates the refresh is in progress.

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

Use DeniedIpAddresses instead. deprecated: true

cassandra_params (CassandraConnectParams): Contains all the additional

params specified by the user while registering the Cassandra source.

couchbase_params (CouchbaseConnectParams): Contains all the additional

params specified by the user while registering the Couchbase source.

environments (list of EnvironmentRegisteredSourceInfoEnum): Specifies

a list of applications environment that are registered with this Protection Source such as ‘kSQL’. 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.

hbase_params (HBaseConnectParams): Contains all the additional params

specified by the user while registering the HBase source.

hdfs_params (HdfsConnectParams): Contains all the additional params

specified by the user while registering the Hdfs source.

hive_params (HiveConnectParams): Contains all the additional params

specified by the user while registering the Hive source.

is_db_authenticated (bool): Specifies if application entity

dbAuthenticated or not. ex: oracle database.

minimum_free_space_gb (long|int): Specifies the minimum free space in

GiB of the space expected to be available on the datastore where the virtual disks of the VM being backed up. If the amount of free space(in GiB) is lower than the value given by this field, backup will be aborted. Note that this field is applicable only to ‘kVMware’ type of environments.

mongodb_params (MongoDBConnectParams): Contains all the additional

params specified by the user while registering the MongoDB source.

nas_mount_credentials (NasMountCredentialParams): Specifies the

credentials required to mount directories on the NetApp server if given.

office_365_credentials_list (list of Office365Credentials): Specifies the

credentials to authenticate with Office365 account.

office_365_region (string): Specifies the region for Office365. password (string): Specifies password of the username to access the

target source.

refresh_error_message (string): Specifies a message if there was any

error encountered during the last rebuild of the Protection Source tree. If there was no error during the last rebuild, this field is reset.

refresh_time_usecs (long|int): Specifies the Unix epoch time (in

microseconds) when the Protection Source tree was most recently fetched and built.

registered_apps_info (list of RegisteredAppInfo): Specifies

information of the applications registered on this protection source.

registration_time_usecs (long|int): Specifies the Unix epoch time (in

microseconds) when the Protection Source was registered.

subnets (list of Subnet): Specifies the list of subnets added during

creation or updation of vmare source. Currently, this field will only be populated in case of VMware registration.

throttling_policy (ThrottlingPolicyParameters): Specifies the

throttling policy for a registered Protection 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.

use_vm_bios_uuid (bool): Specifies if registered vCenter is using BIOS

UUID to track virtual machines.

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

for performing the backup/restore of this entity.

warning_messages (list of string): Specifies a list of warnings

encountered during registration. Though the registration may succeed, warning messages imply the host environment requires some cleanup or fixing.

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.