clustergroup get cgtable

Retrieves the cluster group table information.

If you have imported an external NFS server or an external S3 server, the details of the external NFS server or the external S3 server are displayed when you run the command, alongside the details of clusters in the clustergroup.

See clustergroup addexternal for details to add or import an external NFS server or an external S3 server into a cluster group.

Syntax

CLI 
maprcli clustergroup getcgtable
   [ -showprimary display cluster info for cluster group primary only. default: false ]
   [ -clustername name of cluster ]
   [ -getlicenseinfo get license info. default: false ]
REST
Request Type GET
Request URL 
http[s]://<host>:<port>/rest/clustergroup/getcgtable?<parameters>

Parameters

Parameter Description
showprimary (Optional) Displays cluster information only for the primary cluster group. Default: false.
clustername (Optional) Name of the cluster for which to fetch the cluster information. By default, the information is fetched only for the cluster to which the node on which the command is run belongs. You can specify the name of the external NFS server or the external S3 server that has been imported into the clustergroup, if you wish to view details of the external NFS server or the external S3 server.
getlicenseinfo (Optional) Display the license information for the clusters in the cluster group. Default: false.

Example

Returns the cluster group information:


# maprcli clustergroup getcgtable -json
{
        "timestamp":1698211002789,
        "timeofday":"2023-10-24 10:16:42.789 GMT-0700 PM",
        "status":"OK",
        "total":3,
        "data":[
                {
                        "clustername":"secure-cluster1",
                        "cldbips":"<ip address list>",
                        "apiips":"<ip address list>",
                        "clusterid":"4217876076225350765",
                        "crossclusterticket":"<cross cluster ticket value>",
                        "clustergroupprimary":true,
                        "clusterupgradestate":"UPDATE_STATUS_UNKNOWN",
                        "clusterlocation":"OnPrem",
                        "clusterowner":"",
                        "installtype":"MANUAL_INSTALL",
                        "mossips":"<ip address list>",
                        "gatewayips":"<ip address list>"
                },
                {
                        "clustername":"secure-cluster3",
                        "cldbips":"<ip address list>",
                        "apiips":"<ip address list>",
                        "clusterid":"1603384556630536671",
                        "crossclusterticket":"<cross cluster ticket value>",
                        "clusterupgradestate":"UPDATE_STATUS_UNKNOWN",
                        "clusterlocation":"OnPrem",
                        "clusterowner":"",
                        "installtype":"MANUAL_INSTALL",
                        "mossips":"<ip address list>",
                        "gatewayips":"<ip address list>"
                },
                {  
                      "externalservertype":"ExtNfs",
                      "externalnfsserverpath":"exttestnfs",
                      "externalnfsserverips":"10.161.163.160"
                }
        ]
}

Returns cluster group information for cluster group with external S3 servers.


# maprcli clustergroup getcgtable -json
{	"timestamp":1698338893317,
	"timeofday":"2023-10-26 04:48:13.317 GMT+0000 PM",
	"status":"OK",
	"total":4,
	"data":[
		{
			"clustername":"at-gcp-2610-1",
			"cldbips":"<ip address list>",
			"apiips":"<ip address list>",
			"clusterid":"2021233822172443665",
			"crossclusterticket":"snTFSUmlo8oylcb+lyD1TqqEFyKmMBkw6NWDWicJQPNtXtSXOYSa0x/yBe+62myzbqmjAOvzIi3ymSAPj0jUuHZJqoU5dZe0Wq6PNYCOLzubRZ5Mz97g0wJHrP11l/O5QwGpwvs9B94M02XjTkdl1F1fkVW8iMjilSfKF2W7gyMS09iEuS0WABUFZTd5yDY8q0MJJ5ZroBU+y8Zcvl7l/nwoBRFU7hxdqLFWT+cWi6FCoFt+lGfted5gF4jAmUACsE0RTz5OwksTFg/NGb3nvlSKiivNQezx4o2l9RdommtD1Mkujniex/noMg==",
			"clusterupgradestate":"UPDATE_STATUS_UNKNOWN",
			"clusterlocation":"GCP",
			"clusterowner":"admin",
			"installtype":"AUTO_INSTALL",
			"mossips":"<ip address list>",
			"gatewayips":"<ip address list>"
		},{
			"clustername":"al-s3gns-2610",
			"cldbips":"<ip address list>",
			"apiips":"<ip address list>",
			"clusterid":"8535743913630761757",
			"crossclusterticket":"<cross-cluster-ticket>",
			"clustergroupprimary":true,
			"clusterupgradestate":"UPDATE_STATUS_UNKNOWN",
			"clusterlocation":"AWS",
			"clusterowner":"mapr",
			"installtype":"AUTO_INSTALL",
			"mossips":"<ip address list>",
			"gatewayips":"<ip address list>"
		},
		{
			"externalservertype":"ExtS3",
			"externalservername":"exts3",
			"awsregion":"us-west-1",
			"s3vendor":"AWS"
		},
		{
			"externalservertype":"ExtS3",
			"externalservername":"myaws",
			"awsregion":"us-west-1",
			"s3vendor":"AWS"
		}
	]
}
Shows the primary:

# maprcli clustergroup getcgtable -showprimary true -json
{
        "timestamp":1698213303438,
        "timeofday":"2023-10-24 10:55:03.438 GMT-0700 PM",
        "status":"OK",
        "total":1,
        "data":[
                {
                        "clustername":"secure-cluster1",
                        "cldbips":"<ip address list>",
                        "apiips":"<ip address list>",
                        "clusterid":"4217876076225350765",
                        "crossclusterticket":"<cross cluster ticket value>",
                        "clustergroupprimary":true,
                        "clusterupgradestate":"UPDATE_STATUS_UNKNOWN",
                        "clusterlocation":"OnPrem",
                        "clusterowner":"",
                        "installtype":"MANUAL_INSTALL",
                        "mossips":"<ip address list>",
                        "gatewayips":"<ip address list>"
                }
        ]
}
Shows the cluster name:
# maprcli clustergroup getcgtable -clustername c3 -json
{
    "timestamp":1682487987480,
    "timeofday":"2023-04-25 10:46:27.480 GMT-0700 PM",
    "status":"OK",
    "total":1,
    "data":[
        {
            "clustername":"c3",
            "cldbips":"<cldb IP address list>",
            "apiips":"<api ip address list>",
            "clusterid":"5671109873516702505",
            "crossclusterticket":"<cross cluster ticket value>"
        }
    ]
}
REST
NOTE
When using a self-signed certificate, pass the -k option to curl to avoid the certificate check.
curl -k -u <username> -X GET https://abc.sj.us:8443/rest/clustergroup/getcgtable?getlicenseinfo=true
{"timestamp":1715260351052,"timeofday":"2024-05-09 06:12:31.052 GMT-0700 AM","status":"OK","total":1,"data":[{"clustername":"auto_onprem1715192865778","cldbips":"10.163.162.122:7222 10.163.162.121:7222 10.163.162.123:7222","apiips":"m2-hux6k-32-n3.mip.storage.hpecorp.net, m2-hux6k-32-n2.mip.storage.hpecorp.net, m2-hux6k-32-n1.mip.storage.hpecorp.net","clusterid":"4528254457700513052","crossclusterticket":"t1N1Dll3wj/S6N7EihbJeOv0rY/MnC9CurfFFiWvWX1aBU7X9pEDWL2Or6CVTdNeteO99xQJrUsZB+bgXrXSPkYU/+bjh77udDi6Dv0raQy4TCPtU/jDkEFAjQdKlt/6x4WV1nrPBSL0jpEKux4GAN2TLLSaGI6T+FmPOR082TTAeoGdKJwq+crCmJZtSJKOubkEWqEj3IoNgsixCscY7nz/9SOD5NKwbaULJISjll34pv8+6O31zSfVMWOSDZv6ofqpGr3tPg0jA74tveDZzmMXptLeQWvVhNJxvtvx6/YYf3PqIabL","clustergroupprimary":true,"clusterupgradestate":"UPDATE_STATUS_UNKNOWN","clusterlocation":"OnPrem","clusterowner":"root","installtype":"AUTO_INSTALL","mossips":"m2-hux6k-32-n3.mip.storage.hpecorp.net, m2-hux6k-32-n2.mip.storage.hpecorp.net, m2-hux6k-32-n4.mip.storage.hpecorp.net, m2-hux6k-33-n1.mip.storage.hpecorp.net, m2-hux6k-33-n2.mip.storage.hpecorp.net, m2-hux6k-32-n1.mip.storage.hpecorp.net","MossServerExtIPs":"","gatewayips":"m2-hux6k-32-n3.mip.storage.hpecorp.net, m2-hux6k-32-n2.mip.storage.hpecorp.net, m2-hux6k-32-n1.mip.storage.hpecorp.net","licenseinfo":{"ANY_LICENSE_APPLIED":true,"TERM_LICENSE_APPLIED":true,"TERM_LICENSE_EXPIRED":false,"CONSUMPTION_LICENSE_APPLIED":false,"CONSUMPTION_LICENSE_EXPIRED":false,"CONSUMPTION_LICENSE_ACTIVE":false,"CONSUMPTION_LICENSE_ACTIVATION_KEY_ACTIVE":false,"CONSUMPTION_LICENSE_ACTIVATION_KEY_EXPIRED":false},"s3gnshttpsmode":"FORWARD"}]}