Merge pull request #46 from datamattsson/docs120

Docs for 1.2.0
hpe-storage · Mar 18, 2021 · 8df8fb0 · 8df8fb0
2 parents 073e8fe + 1d7e30e
commit 8df8fb0
Show file tree

Hide file tree

Showing 9 changed files with 162 additions and 64 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
diff --git 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
@@ -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
@@ -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
@@ -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'