From 1d7e30eb24571a1d44a83250b5a9c47167ba9b37 Mon Sep 17 00:00:00 2001 From: Michael Mattsson Date: Thu, 18 Mar 2021 14:49:04 -0700 Subject: [PATCH] Docs for 1.2.0 Signed-off-by: Michael Mattsson --- docs/api/arrays.md | 2 +- docs/api/controllers.md | 1 + docs/api/groups.md | 1 + docs/api/ldap_domains.md | 32 ++++++++ docs/api/protection_schedules.md | 130 ++++++++++++++++--------------- docs/api/snapshot_collections.md | 1 + docs/api/subscribers.md | 28 +++++++ docs/api/subscriptions.md | 28 +++++++ mkdocs.yml | 3 + 9 files changed, 162 insertions(+), 64 deletions(-) create mode 100644 docs/api/ldap_domains.md create mode 100644 docs/api/subscribers.md create mode 100644 docs/api/subscriptions.md diff --git a/docs/api/arrays.md b/docs/api/arrays.md index a19fc68..418ab98 100644 --- a/docs/api/arrays.md +++ b/docs/api/arrays.md @@ -49,7 +49,7 @@ __Parameters__ - __extended_model __: Extended model of the array. - __is_supported_hw_config __: Whether it is a supported hardware config. - __gig_nic_port_count __: Count of 1G NIC Ports installed on the array. -- __ten_gig_sfp_nic_port_count __: Count of 10G SFP NIC Ports installed on the array. +- __ten_gig_sfp_nic_port_count __: Count of SFP NIC Ports installed on the array capable of 10G, 25G or 100G speeds. - __ten_gig_t_nic_port_count __: Count of 10G BaseT NIC Ports installed on the array. - __fc_port_count __: Count of Fibre Channel Ports installed on the array. - __public_key __: Public key of the array. diff --git a/docs/api/controllers.md b/docs/api/controllers.md index 25f450c..3fe1292 100644 --- a/docs/api/controllers.md +++ b/docs/api/controllers.md @@ -16,6 +16,7 @@ __Parameters__ - __array_id __: Rest ID of the array containing this controller. - __partial_response_ok __: Indicate that it is ok to provide partially available response. - __serial __: Serial number for this controller. +- __model __: Model of this controller. - __hostname __: Host name for the controller. - __support_address __: IP address used for support. - __support_netmask __: IP netmask used for support. diff --git a/docs/api/groups.md b/docs/api/groups.md index 6a044cd..65c1189 100644 --- a/docs/api/groups.md +++ b/docs/api/groups.md @@ -49,6 +49,7 @@ __Parameters__ - __syslogd_enabled __: Is syslogd enabled on this system. - __syslogd_server __: Hostname of the syslogd server. - __syslogd_port __: Port number for syslogd server. +- __syslogd_servers __: Hostname and/or port of the syslogd servers. - __vvol_enabled __: Are vvols enabled on this group. - __iscsi_enabled __: Whether iSCSI is enabled on this group. - __fc_enabled __: Whether FC is enabled on this group. diff --git a/docs/api/ldap_domains.md b/docs/api/ldap_domains.md new file mode 100644 index 0000000..e7a5de1 --- /dev/null +++ b/docs/api/ldap_domains.md @@ -0,0 +1,32 @@ + +# nimbleclient.v1.api.ldap_domains + + +## LdapDomain +```python +LdapDomain(self, id, attrs=None, client=None, collection=None) +``` +Manages the storage array's membership with LDAP servers. + +__Parameters__ + +- __id __: Identifier for the LDAP Domain. +- __domain_name __: Domain name. +- __domain_description __: Description of the domain. +- __domain_enabled __: Indicates whether the LDAP domain is currently active or not. +- __server_uri_list __: A set of up to 3 LDAP URIs. +- __bind_user __: Full Distinguished Name of LDAP admin user. If empty, attempt to bind anonymously. +- __bind_password __: Password for the Full Distinguished Name of LDAP admin user. This parameter is mandatory if the bind_user is given. +- __base_dn __: The Distinguished Name of the base object from which to start all searches. +- __user_search_filter __: Limit the results returned based on specific search criteria. +- __user_search_base_list __: A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for User objects. +- __group_search_filter __: Limit the results returned based on specific search criteria. +- __group_search_base_list __: A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for Group objects. +- __schema_type __: Enum values are OpenLDAP or AD. + + +## LdapDomainList +```python +LdapDomainList(self, client=None) +``` + diff --git a/docs/api/protection_schedules.md b/docs/api/protection_schedules.md index 829b5c7..314954f 100644 --- a/docs/api/protection_schedules.md +++ b/docs/api/protection_schedules.md @@ -10,69 +10,73 @@ Manage protection schedules used in protection templates. __Parameters__ -- __id __: Identifier for protection schedule. -- __name __: Name of snapshot schedule to create. -- __description __: Description of the schedule. -- __volcoll_or_prottmpl_type __: Type of the protection policy this schedule is attached to. Valid values are protection_template and volume_collection. -- __volcoll_or_prottmpl_id __: Identifier of the protection policy (protection_template or volume_collection) in which this protection schedule is attached to. -- __period __: Repeat interval for snapshots with respect to the period_unit. For example, a value of 2 with the 'period_unit' of 'hours' results in one - snapshot every 2 hours. -- __period_unit __: Time unit over which to take the number of snapshots specified in 'period'. For example, a value of 'days' with a 'period' of '1' results in - one snapshot every day. -- __at_time __: Time of day when snapshot should be taken. In case repeat frequency specifies more than one snapshot in a day then the until_time option - specifies until what time of day to take snapshots. -- __until_time __: Time of day to stop taking snapshots. Applicable only when repeat frequency specifies more than one snapshot in a day. -- __days __: Specifies which days snapshots should be taken. -- __num_retain __: Number of snapshots to retain. If replication is enabled on this schedule the array will always retain the latest replicated snapshot, which - may exceed the specified retention value. This is necessary to ensure efficient replication performance. -- __downstream_partner __: Specifies the partner name if snapshots created by this schedule should be replicated. -- __downstream_partner_name __: Specifies the partner name if snapshots created by this schedule should be replicated. -- __downstream_partner_id __: Specifies the partner ID if snapshots created by this schedule should be replicated. In an update operation, if snapshots should be replicated, - set this attribute to the ID of the replication partner. If snapshots should not be replicated, set this attribute to the empty string. -- __upstream_partner_name __: Specifies the partner name from which snapshots created by this schedule are replicated. -- __upstream_partner_id __: Specifies the partner ID from which snapshots created by this schedule are replicated. -- __replicate_every __: Specifies which snapshots should be replicated. If snapshots are replicated and this option is not specified, every snapshot is replicated. -- __num_retain_replica __: Number of snapshots to retain on the replica. -- __repl_alert_thres __: Replication alert threshold in seconds. If the replication of a snapshot takes more than this amount of time to complete an alert will be - generated. Enter 0 to disable this alert. -- __snap_verify __: Run verification tool on snapshot created by this schedule. This option can only be used with snapshot schedules of a protection template that - has application synchronization. The tool used to verify snapshot depends on the type of application. For example, if application - synchronization is VSS and the application ID is Exchange, eseutil tool is run on the snapshots. If verification fails, the logs are not - truncated. -- __skip_db_consistency_check __: Skip consistency check for database files on snapshots created by this schedule. This option only applies to snapshot schedules of a protection - template with application synchronization set to VSS, application ID set to MS Exchange 2010 or later w/DAG, this schedule's snap_verify option - set to yes, and its disable_appsync option set to false. Skipping consistency checks is only recommended if each database in a DAG has multiple - copies. -- __disable_appsync __: Disables application synchronized snapshots and creates crash consistent snapshots instead. -- __schedule_type __: Normal schedules have internal timers which drive snapshot creation. An externally driven schedule has no internal timers. All snapshot - activity is driven by an external trigger. In other words, these schedules are used only for externally driven manual snapshots. -- __active __: A schedule is active only if it is owned by the same owner as the volume collection. Only active schedules of a volume collection participate - in the creation of snapshots and replication. -- __creation_time __: Time when this protection schedule was created. -- __last_modified __: Time when this protection schedule was last modified. -- __last_mod_sched_time __: Time when the timing of the protection schedule was last modified. -- __last_replicated_snapcoll_name __: Specifies the name of last replicated snapshot collection. -- __last_replicated_snapcoll_id __: Specifies the snapshot collection ID of last replicated snapshot collection. -- __last_replicated_at_time __: Time when last snapshot collection was replicated. -- __last_snap_time __: Time when last snapshot was taken. -- __next_snap_time __: Time when next snapshot will be taken. -- __next_repl_snap_time __: Time when next snapshot will be replicated. -- __snap_counter __: This is only used by custom read handler for internal calculations. -- __sched_owner_id __: Identifier of the group that owns this schedule. -- __sched_owner_name __: Name of the group that owns this schedule. -- __last_config_change_time __: The last timing configutation changed. -- __vol_status_list __: The list of the replication status of volumes undergoing replication. -- __sync_repl_vol_status_list __: A list of the replication status of volumes undergoing synchronous replication. -- __use_downstream_for_DR __: Break synchronous replication for the specified volume collection and present downstream volumes to host(s). Downstream volumes in the volume - collection will be set to online and presented to the host(s) using new serial and LUN numbers. No changes will be made to the upstream - volumes, their serial and LUN numbers, and their online state. The existing ACLs on the upstream volumes will be copied to the downstream - volumes. Use this in conjunction with an empty downstream_partner_id. This unconfigures synchronous replication when the partner is removed - from the last replicating schedule in the specified volume collection and presents the downstream volumes to host(s). Host(s) will need to be - configured to access the new volumes with the newly assigned serial and LUN numbers. Use this option to expose downstream volumes in a - synchronously replicated volume collection to host(s) only when the upstream partner is confirmed to be down and there is no communication - between partners. Do not execute this operation if a previous Group Management Service takeover has been performed on a different array. Do not - perform a subsequent Group Management Service takeover on a different array as it will lead to irreconcilable conflicts. This limitation is - cleared once the Group management service backup array has successfully synchronized after reconnection. +- __id __: Identifier for protection schedule. +- __name __: Name of snapshot schedule to create. +- __description __: Description of the schedule. +- __volcoll_or_prottmpl_type __: Type of the protection policy this schedule is attached to. Valid values are protection_template and volume_collection. +- __volcoll_or_prottmpl_id __: Identifier of the protection policy (protection_template or volume_collection) in which this protection schedule is attached to. +- __period __: Repeat interval for snapshots with respect to the period_unit. For example, a value of 2 with the 'period_unit' of 'hours' results in + one snapshot every 2 hours. +- __period_unit __: Time unit over which to take the number of snapshots specified in 'period'. For example, a value of 'days' with a 'period' of '1' results + in one snapshot every day. +- __at_time __: Time of day when snapshot should be taken. In case repeat frequency specifies more than one snapshot in a day then the until_time option + specifies until what time of day to take snapshots. +- __until_time __: Time of day to stop taking snapshots. Applicable only when repeat frequency specifies more than one snapshot in a day. +- __days __: Specifies which days snapshots should be taken. +- __num_retain __: Number of snapshots to retain. If replication is enabled on this schedule the array will always retain the latest replicated snapshot, + which may exceed the specified retention value. This is necessary to ensure efficient replication performance. +- __downstream_partner __: Specifies the partner name if snapshots created by this schedule should be replicated. +- __downstream_partner_name __: Specifies the partner name if snapshots created by this schedule should be replicated. +- __downstream_partner_id __: Specifies the partner ID if snapshots created by this schedule should be replicated. In an update operation, if snapshots should be + replicated, set this attribute to the ID of the replication partner. If snapshots should not be replicated, set this attribute to the + empty string. +- __upstream_partner_name __: Specifies the partner name from which snapshots created by this schedule are replicated. +- __upstream_partner_id __: Specifies the partner ID from which snapshots created by this schedule are replicated. +- __replicate_every __: Specifies which snapshots should be replicated. If snapshots are replicated and this option is not specified, every snapshot is + replicated. +- __num_retain_replica __: Number of snapshots to retain on the replica. +- __repl_alert_thres __: Replication alert threshold in seconds. If the replication of a snapshot takes more than this amount of time to complete an alert will be + generated. Enter 0 to disable this alert. +- __snap_verify __: Run verification tool on snapshot created by this schedule. This option can only be used with snapshot schedules of a protection template + that has application synchronization. The tool used to verify snapshot depends on the type of application. For example, if application + synchronization is VSS and the application ID is Exchange, eseutil tool is run on the snapshots. If verification fails, the logs are not + truncated. +- __skip_db_consistency_check __: Skip consistency check for database files on snapshots created by this schedule. This option only applies to snapshot schedules of a + protection template with application synchronization set to VSS, application ID set to MS Exchange 2010 or later w/DAG, this schedule's + snap_verify option set to yes, and its disable_appsync option set to false. Skipping consistency checks is only recommended if each + database in a DAG has multiple copies. +- __disable_appsync __: Disables application synchronized snapshots and creates crash consistent snapshots instead. +- __schedule_type __: Normal schedules have internal timers which drive snapshot creation. An externally driven schedule has no internal timers. All snapshot + activity is driven by an external trigger. In other words, these schedules are used only for externally driven manual snapshots. +- __active __: A schedule is active only if it is owned by the same owner as the volume collection. Only active schedules of a volume collection + participate in the creation of snapshots and replication. +- __creation_time __: Time when this protection schedule was created. +- __last_modified __: Time when this protection schedule was last modified. +- __last_mod_sched_time __: Time when the timing of the protection schedule was last modified. +- __last_replicated_snapcoll_name __: Specifies the name of last replicated snapshot collection. +- __last_replicated_snapcoll_id __: Specifies the snapshot collection ID of last replicated snapshot collection. +- __last_replicated_at_time __: Time when last snapshot collection was replicated. +- __last_snap_time __: Time when last snapshot was taken. +- __next_snap_time __: Time when next snapshot will be taken. +- __next_repl_snap_time __: Time when next snapshot will be replicated. +- __snap_counter __: This is only used by custom read handler for internal calculations. +- __sched_owner_id __: Identifier of the group that owns this schedule. +- __sched_owner_name __: Name of the group that owns this schedule. +- __last_config_change_time __: The last timing configutation changed. +- __currently_replicating_snapcoll_name __: The name of the currently replicating snapshot collection if one exists, the empty string otherwise. +- __vol_status_list __: The list of the replication status of volumes undergoing replication. +- __sync_repl_vol_status_list __: A list of the replication status of volumes undergoing synchronous replication. +- __use_downstream_for_DR __: Break synchronous replication for the specified volume collection and present downstream volumes to host(s). Downstream volumes in the + volume collection will be set to online and presented to the host(s) using new serial and LUN numbers. No changes will be made to the + upstream volumes, their serial and LUN numbers, and their online state. The existing ACLs on the upstream volumes will be copied to the + downstream volumes. Use this in conjunction with an empty downstream_partner_id. This unconfigures synchronous replication when the + partner is removed from the last replicating schedule in the specified volume collection and presents the downstream volumes to host(s). + Host(s) will need to be configured to access the new volumes with the newly assigned serial and LUN numbers. Use this option to expose + downstream volumes in a synchronously replicated volume collection to host(s) only when the upstream partner is confirmed to be down and + there is no communication between partners. Do not execute this operation if a previous Group Management Service takeover has been + performed on a different array. Do not perform a subsequent Group Management Service takeover on a different array as it will lead to + irreconcilable conflicts. This limitation is cleared once the Group management service backup array has successfully synchronized after + reconnection. ## ProtectionScheduleList diff --git a/docs/api/snapshot_collections.md b/docs/api/snapshot_collections.md index d5d59c3..3e8e406 100644 --- a/docs/api/snapshot_collections.md +++ b/docs/api/snapshot_collections.md @@ -23,6 +23,7 @@ __Parameters__ snapshot_collection was created by synchronous replication. - __peer_snapcoll_id __: ID of the peer snapshot collection created by synchronous replication. Field will be null if no peer snapshot_collection was created by synchronous replication. +- __num_snaps __: Current number of live, non-hidden snaps in this collection. - __is_complete __: Is complete. - __is_manual __: Is manual. - __is_external_trigger __: Is externally triggered. diff --git a/docs/api/subscribers.md b/docs/api/subscribers.md new file mode 100644 index 0000000..9239afd --- /dev/null +++ b/docs/api/subscribers.md @@ -0,0 +1,28 @@ + +# nimbleclient.v1.api.subscribers + + +## Subscriber +```python +Subscriber(self, id, attrs=None, client=None, collection=None) +``` +Subscribers are websocket based notification clients that can subscribe to interesting operations and events and recieve notifications whenever the subscribed to operations +and events happen on the array. + +__Parameters__ + +- __id __: Identifier for subscriber. +- __type __: This is generally used to indicate the type of subscriber e.g. SMIS/GUI/ThirdParty etc. This is free form and doesn't need to be unique. +- __renew_interval __: The interval in seconds within which the subscriber is expected to send a renew message over the websocket channel in case there is no traffic on the + websocket channel. +- __renew_response_timeout __: The interval in seconds after the subscriber sends a renew message within which the subscriber expects to get a response. +- __is_connected __: True if the subscriber has an active websocket connection. +- __notification_count __: Number of notifications sent to subscriber. +- __force __: Forcibly modify a connected subscriber. + + +## SubscriberList +```python +SubscriberList(self, client=None) +``` + diff --git a/docs/api/subscriptions.md b/docs/api/subscriptions.md new file mode 100644 index 0000000..dac6857 --- /dev/null +++ b/docs/api/subscriptions.md @@ -0,0 +1,28 @@ + +# nimbleclient.v1.api.subscriptions + + +## Subscription +```python +Subscription(self, id, attrs=None, client=None, collection=None) +``` +Subscriptions represent the list of object types or alerts that a websocket client is interested in getting notifications for. Each subscription belongs to a single +notification client. + +__Parameters__ + +- __id __: Identifier for subscription. +- __subscriber_id __: Identifier for subscriber (notification client) that this subscription belongs to. +- __notification_type __: This indicates the type of notification being subscribed for. +- __object_type __: The object type that the notification subscriber is interested in. This is relevant for and required only for audit log based notifications. +- __object_id __: The object that the notification subscriber is interested in. Applies only to audit log based notifications. +- __operation __: The operation that the notification subscriber is interested in. Applies only to audit log based notifications. +- __event_target_type __: The kind of events or alerts that the notification subscriber is interested in. Applies only to events based notifications. +- __event_severity __: The severity of events that the notification subscriber is interested in. Applies only to events based notifications. + + +## SubscriptionList +```python +SubscriptionList(self, client=None) +``` + diff --git a/mkdocs.yml b/mkdocs.yml index 32d93c1..0172df8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -56,6 +56,7 @@ nav: - 'initiators': 'api/initiators.md' - 'jobs': 'api/jobs.md' - 'key_managers': 'api/key_managers.md' + - 'ldap_domains': 'api/ldap_domains.md' - 'master_key': 'api/master_key.md' - 'network_configs': 'api/network_configs.md' - 'network_interfaces': 'api/network_interfaces.md' @@ -71,6 +72,8 @@ nav: - 'software_versions': 'api/software_versions.md' - 'space_domains': 'api/space_domains.md' - 'subnets': 'api/subnets.md' + - 'subscribers': 'api/subscribers.md' + - 'subscriptions': 'api/subscriptions.md' - 'tokens': 'api/tokens.md' - 'user_groups': 'api/user_groups.md' - 'user_policies': 'api/user_policies.md'