Config: GET

Gets information about the configuration of the IBM Storage Scale cluster.

Availability

Available on all IBM Storage Scale editions.

Description

The GET config request gets information about the local cluster. For more information about the fields in the data structures that are returned, see the following topics: mmchconfig command and mmlsconfig command.

This API call gets it data from the mmlsconfig command. The mmlsconfig command displays the PERSISTED configuration values; not the ACTIVE values. That is, the configuration changes made through the mmchconfig command comes in to the effect based on how you use -I and -i parameters of the command. The following three scenarios are applicable:
  • mmchconfig -I: A value is changed immediately in the daemon but not persistent so that it is reset after a restart. Those settings do not show in mmlsconfig at all. In this case, this API call shows an old setting that is temporarily changed to something else.
  • mmchconfig -i: The setting takes effect immediately and is also persisted so that mmlsconfig shows it.
  • mmchconfig: The setting takes effect on the next restart and is also persisted so that mmlsconfig shows it. In this case, the API call shows a future setting that will get applied after the restart.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/config
where
config
Specifies that the GET request fetches the configuration details of the cluster.

Request headers

Content-Type: application/json
Accept: application/json

Parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of parameters
Parameter name Description and applicable keywords Required/optional
fields Comma separated list of fields to be included in response. ':all:' selects all available fields. Optional.

Request data

No request data.

Response data

The following list of attributes are available in the response data:

{      
"status":
   {
      "code": ReturnCode
      "message": "ReturnMessage",   
   }
   "config": [
      {
         "clusterConfig": "Configuration details"
        
       }
}
"status":
Return status.
"code": ReturnCode,
The HTTP status code that was returned by the request.
"message": "ReturnMessage"
The return message.
"config":
An array of information about the cluster configuration.
"clusterConfig": "Configuration details"
The cluster configuration as shown by mmlsconfig -Y command.

The return information and the information that the command retrieves are returned in the same way as they are for the other requests. The parameters that are returned are the same as the configuration attributes that are displayed by the mmlsconfig command. For more information, see the mmlsconfig command.

Examples

The following example gets information about the cluster configuration.

Request data: 
curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/config'
Response data:
Note: In the JSON data that is returned, the return code indicates whether the command is successful. The response code 200 indicates that the command successfully retrieved the information. Error code 400 represents an invalid request and 500 represents internal server error.
The config array provides information about the cluster configuration. 
{
  "config" : {
    "clusterConfig" : {
      "FIPS1402mode" : "no",
      "adminMode" : "central",
      "afmAsyncDelay" : "15",
      "afmAsyncOpWaitTimeout" : "120",
      "afmAtimeXattr" : "no",
      "afmDIO" : "0",
      "afmDirLookupRefreshInterval" : "60",
      "afmDirOpenRefreshInterval" : "60",
      "afmDisconnectTimeout" : "60",
      "afmEnableADR" : "no",
      "afmExpirationTimeout" : "disable",
      "afmFileLookupRefreshInterval" : "30",
      "afmFileOpenRefreshInterval" : "30",
      "afmFlushThreadDelay" : "5",
      "afmGatewayQueueTransfer" : "yes",
      "afmHardMemThreshold" : "5368709120",
      "afmMaxThrottle" : "0",
      "afmMaxWriteMergeLen" : "1073741824",
      "afmMode" : "read-only",
      "afmMountRetryInterval" : "300",
      "afmNumIOFlushThreads" : "32",
      "afmNumReadThreads" : "1",
      "afmNumWriteThreads" : "1",
      "afmParallelReadChunkSize" : "134217728",
      "afmParallelReadThreshold" : "1024",
      "afmParallelWriteChunkSize" : "134217728",
      "afmParallelWriteThreshold" : "1024",
      "afmRPO" : "disable",
      "afmReadBufferSize" : "33554432",
      "afmReadFlags" : "cached",
      "afmReadSparseThreshold" : "134217728",
      "afmShowHomeSnapshot" : "no",
      "afmSkipWrites" : "(undefined)",
      "afmSyncOpWaitTimeout" : "60",
      "afmWriteBufferSize" : "2097152",
      "atimeDeferredSeconds" : "86400",
      "autoload" : "yes",
      "automountDir" : "/gpfs/automountdir",
      "ccrEnabled" : "yes",
      "cesSharedRoot" : "/mnt/objfs/ces",
      "cifsBypassShareLocksOnRename" : "yes",
      "cifsBypassTraversalChecking" : "yes",
      "cipherList" : "AUTHONLY",
      "clusterId" : "317908494281353658",
      "clusterName" : "gpfsgui-cluster-1.localnet.com",
      "cnfsMountdPort" : "(undefined)",
      "cnfsNFSDprocs" : "32",
      "cnfsReboot" : "yes",
      "cnfsSharedRoot" : "(undefined)",
      "commandAudit" : "syslogOnly",
      "dataCollectionPendingDelay" : "10",
      "dataDiskCacheProtectionMethod" : "0",
      "dataDiskWaitTimeForRecovery" : "3600",
      "dataStructureDump" : "/tmp/mmfs",
      "deadlockBreakupDelay" : "0",
      "deadlockDataCollectionDailyLimit" : "3",
      "deadlockDataCollectionMinInterval" : "3600",
      "deadlockDetectionThreshold" : "300",
      "deadlockDetectionThresholdForShortWaiters" : "60",
      "deadlockDetectionThresholdIfOverloaded" : "1800",
      "deadlockOverloadThreshold" : "1",
      "debugDataControl" : "light",
      "debugDataControlOnSignal" : "heavy",
      "defaultHelperNodes" : "(undefined)",
      "defaultMountDir" : "/gpfs",
      "disableInodeUpdateOnFdatasync" : "no",
      "dmapiDataEventRetry" : "2",
      "dmapiEventTimeout" : "86400000",
      "dmapiFileHandleSize" : "32",
      "dmapiMountEvent" : "all",
      "dmapiMountTimeout" : "60",
      "dmapiSessionFailureTimeout" : "0",
      "enableIPv6" : "no",
      "enforceFilesetQuotaOnRoot" : "no",
      "expelDataCollectionDailyLimit" : "3",
      "expelDataCollectionMinInterval" : "3600",
      "failureDetectionTime" : "35",
      "fastestPolicyCmpThreshold" : "50",
      "fastestPolicyMaxValidPeriod" : "600",
      "fastestPolicyMinDiffPercent" : "50",
      "fastestPolicyNumReadSamples" : "5",
      "fileHeatLossPercent" : "10",
      "fileHeatPeriodMinutes" : "0",
      "indefiniteRetentionProtection" : "no",
      "indirectBlocksPerLockRange" : "10",
      "maxDownDisksForRecovery" : "16",
      "maxFailedNodesForRecovery" : "3",
      "maxFcntlRangesPerFile" : "200",
      "maxFilesToCache" : "4000",
      "maxMBpS" : "2048",
      "maxStatCache" : "1000",
      "maxblocksize" : "16384K",
      "metadataDiskWaitTimeForRecovery" : "2400",
      "minDiskWaitTimeForRecovery" : "1800",
      "minReleaseLevel" : "4.2.3.0",
      "minimumTargetTimeUnderRangeLock" : "30",
      "mmapRangeLock" : "yes",
      "mmfsLogLevel" : "detail",
      "nistCompliance" : "SP800-131A",
      "noSpaceEventInterval" : "120",
      "nsdRAIDBufferPoolSizePct" : "50",
      "nsdRAIDTracks" : "0",
      "nsdServerWaitTimeForMount" : "300",
      "nsdServerWaitTimeWindowOnMount" : "600",
      "nsdbufspace" : "30",
      "pagepool" : "1G",
      "pagepoolMaxPhysMemPct" : "75",
      "pitWorkerThreadsPerNode" : "0",
      "prefetchThreads" : "72",
      "readReplicaPolicy" : "default",
      "restripeOnDiskFailure" : "no",
      "rpcPerfNumberDayIntervals" : "30",
      "rpcPerfNumberHourIntervals" : "24",
      "rpcPerfNumberMinuteIntervals" : "60",
      "rpcPerfNumberSecondIntervals" : "60",
      "rpcPerfRawExecBufferSize" : "2",
      "rpcPerfRawStatBufferSize" : "6",
      "sidAutoMapRangeLength" : "15000000",
      "sidAutoMapRangeStart" : "15000000",
      "subnets" : "(undefined)",
      "syncSambaMetadataOps" : "yes",
      "systemLogLevel" : "notice",
      "tctEnable" : "yes",
      "tiebreakerDisks" : "(undefined)",
      "tmMaxPhysMemPct" : "75",
      "tscCmdPortRange" : "(undefined)",
      "uidDomain" : "localnet.com",
      "unmountOnDiskFail" : "no",
      "usePersistentReserve" : "no",
      "verbsPorts" : "(undefined)",
      "verbsRdma" : "disable",
      "verbsRdmaCm" : "disable",
      "verbsRdmaPkey" : "32767",
      "verbsRdmaRoCEToS" : "-1",
      "verbsRdmaSend" : "no",
      "verbsRdmasPerConnection" : "16",
      "worker1Threads" : "48"
    }
  },
  "status" : {
    "code" : 200,
    "message" : "The request finished successfully"
  }
}