Skip to main content
Element Software
12.5 and 12.7

ListClusterAdmins

Contributors netapp-pcarriga

You can use the ListClusterAdmins method to return the list of all cluster administrators for the cluster.

There can be several cluster administrator accounts with different levels of permissions. There can be only one primary cluster administrator in the system. The primary Cluster Admin is the administrator that was created when the cluster was created. LDAP administrators can also be created when setting up an LDAP system on the cluster.

Parameters

This method has the following input parameter:

Name Description Type Default value Required

showHidden

Shows hidden cluster administrator users, such as SNMP admin.

boolean

None

No

Return value

This method has the following return value:

Name

Description

Type

clusterAdmins

Information about all cluster and LDAP administrators that exist for a cluster.

clusterAdmin array

Request example

Requests for this method are similar to the following example:

{
   "method": "ListClusterAdmins",
   "params": {},
    "showHidden": true
   "id" : 1
}

Response example

This method returns a response similar to the following example:

{
"id":1,
"result":{
  "clusterAdmins":[
     {
       "access":[
           "administrator"
       ],
       "attributes":null,
       "authMethod":"Cluster",
       "clusterAdminID":1,
       "username":"admin"
   },
   {
       "access":[
           "read",
           "administrator"
       ],
       "attributes":{
       },
       "authMethod":"Ldap",
       "clusterAdminID":7,
       "username":"john.smith"
   },
   {
       "access":[
           "read",
           "administrator"
       ],
       "attributes":{},
       "authMethod":"Ldap",
       "clusterAdminID":6,
       "username":"cn=admin1 jones,ou=ptusers,c=prodtest,dc=solidfire,dc=net"
       }
     ]
   }
}

New since version

9.6