{ "openapi": "3.0.3", "info" : { "description" : "

REST API documentation for IBM Copy Services Manager<\/h1>\n \t\t
\n \t\t\t

The RESTful (Representational State Transfer) API is a platform independent means by which to initiate create, read, update, and delete operations to the Copy Services Manager server. These operations are initiated with the HTTP commands: POST, GET, PUT, and DELETE.<\/p>\n\t\t\t

The RESTful API is intended for programmatically managing a replication environment managed by Copy Services Manager. You can use the RESTful API with a CURL command or through standard Web browsers.<\/p>\n\t\t\t

Copy Services Manager has externalized a majority of the APIs necessary to programmatically manage actions on the server through a RESTful interface. If there are any actions missing, please open a Request For Enhancement (RFE) so that the missing APIs can be addressed. Open an RFE on CSM<\/a> <\/p>\n\t\t\t

URL Structure<\/h1>The URL structure for an operation is https://ip_address:port_number/service/<\/i>... where ip_address is the IP address of the Copy Services Manager server, port_number is the 3-4 digit port number for the server, and service is defined by the type of request service which can be found in the RESTful API command documentation.<\/br>NOTE: The port may be optional for HMC installations.<\/i><\/p>\n\t\t\t

Security<\/h1>Copy Services Manager supports multiple authentication methods: Basic Authentication<\/code>, Session Tokens<\/code>, Personal Access Tokens (PAT)<\/code>, and Certificate Authentication<\/code>. Choose the method that best fits your use case.<\/p>\n\t\t\t

Using Basic Authentication<\/h2>Use the following steps as an example of using HTTP Basic Authentication to call the CSM RESTful API. When using Basic Authentication the following must be done for each and every HTTP command sent.<\/p>\n\t\t\t

  1. Open Firefox browser. <\/li>
  2. Open the RESTful client by selecting Tools > RESTClient<\/b>.<\/li>
  3. Select Authentication<\/b> pull down from top. <\/li>
  4. Select Basic Authentication<\/b>. <\/li>
  5. Enter username<\/b> and password<\/b>. <\/li>
  6. Fill in the rest of the RESTClient to complete the desired request according to the request documentation and click Send<\/b>.<\/li><\/ol><\/p>\n\t\t\t

    Example curl command using Basic Authentication.<\/br>curl -X GET -k -H 'Accept-Language: fr,en-US' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://hostname:9559/CSM/web/sessions/<\/code><\/p>\n\t\t\t

    Using Session Token Authentication<\/h2><\/p>\n\t\t\t

    Requesting a Session Token for Authentication<\/h3>Use the following steps to request a session token to use when calling the CSM RESTful API. Session tokens are temporary and expire after 2 hours of inactivity.<\/p>\n\t\t\t

    1. Open Firefox browser. <\/li>
    2. Open the RESTful client by selecting Tools > RESTClient<\/b>.<\/li>
    3. Select Headers<\/b> pull down from top. <\/li>
    4. Select Custom Header<\/b>. <\/li>
    5. Under the Name type Content-Type<\/b> . Under the attribute value type application/x-www-form-urlencoded<\/b>. <\/li>
    6. Under Method select Post<\/b>.<\/li>
    7. In the URL field, type https://address:port/CSM/web/system/v1/tokens<\/i><\/b> where address is the IP address of the Copy Services Manager server, and port is a four-digit port number. <\/li>
    8. In the Form Editior for the Body add two fields. username<\/b> where you specify the name of a user who has access to the server, and password<\/b> where you specify the password for that user.<\/li>
    9. Click Send<\/b><\/li><\/ol><\/p>\n\t\t\t

      Example curl command to request a session token.<\/br>curl -X POST -k -H 'Accept-Language: en-US' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/system/v1/tokens --data 'username=csmadmin&password=csm'<\/code><\/p>\n\t\t\t

      Example result for session token request. Result is in json format where the key token<\/code> provides the token that should be used on calls to the RESTful API. The key expire_time_milliseconds<\/code> provides the time in milliseconds since January 1, 1970, 00:00:00 GMT when the token will expire and a new token will need to be requested.<\/p>\n\t\t\t

      { \"msg\": \"IWNR4005I\", \"expire_time_milliseconds\": 1586548094513, \"inserts\": [\"csmadmin\"],\"user\": \"csmadmin\",\"msgTranslated\": \"IWNR4005I [Apr 10, 2020 12:48:14 PM] Successfully authenticated user {1}.\",\"created_time_milliseconds\": 1586540894513,\"timestamp\": 1586540894513,\"token\": \"008d4b1e4dd54501a537340842e7b4d7\"}<\/code><\/p>\n\t\t\t

      Using session token authentication when calling the server<\/h3>When calling the RESTful API using session token authentication, after requesting a token the token received should be supplied in a custom header named X-Auth-Token<\/code> on all subsequent calls.<\/br>Please note that session tokens are designed to be more secure. By default the token will automatically expire after 2 hours of inactivity and a new token request will be required.<\/b><\/p>\n\t\t\t

      1. Open Firefox browser. <\/li>
      2. Open the RESTful client by selecting Tools > RESTClient<\/b>.<\/li>
      3. Select Headers<\/b> pull down from top. <\/li>
      4. Select Custom Header<\/b>. <\/li>
      5. Under the header name type Content-Type<\/b> . Under the attribute value type application/x-www-form-urlencoded<\/b>. <\/li>
      6. Select Custom Header again. Under the header name type X-Auth-Token<\/b> . Under the attribute value type the token received when requesting a token. Example: 008d4b1e4dd54501a537340842e7b4d7<\/code><\/li>
      7. Fill in the rest of the RESTClient to complete the desired request according to the request documentations and click Send<\/b>.<\/li><\/ol><\/p>\n\t\t\t

        Example curl command using a session token.<\/br>curl -X POST -k -H 'X-Auth-Token: 008d4b1e4dd54501a537340842e7b4d7' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/8kFC --data cmd=Flash<\/code><\/p>\n\t\t\t

        Using Personal Access Token (PAT) Authentication<\/h2><\/p>\n\t\t\t

        Personal Access Tokens provide a more secure and convenient way to authenticate API calls without exposing passwords. PATs are long-lived tokens that can be managed through the GUI and are ideal for automation, scripts, and CI/CD pipelines.<\/p>\n\t\t\t

        Creating a Personal Access Token<\/h3>Personal Access Tokens must be created through the Copy Services Manager GUI:<\/p>\n\t\t\t

        1. Log in to the CSM GUI with your username and password<\/li>
        2. Click on your username in the top right corner<\/li>
        3. Select Manage Authentication<\/b> from the dropdown menu<\/li>
        4. Click Generate New Token<\/b><\/li>
        5. Enter a description for the token (e.g., \"Jenkins CI/CD Pipeline\")<\/li>
        6. Optionally set an expiration date (tokens without expiration never expire)<\/li>
        7. Click Generate<\/b><\/li>
        8. Important:<\/b> Copy the token immediately - it will only be shown once!<\/li><\/ol><\/p>\n\t\t\t

          Using Personal Access Token authentication when calling the server<\/h3>When calling the RESTful API using PAT authentication, supply the token in the Authorization<\/code> header with the Bearer<\/code> scheme:<\/p>\n\t\t\t

          Example curl command using a Personal Access Token.<\/br>curl -X GET -k -H 'X-Auth-Token: 008d4b1e4dd54501a537340842e7b4d7' -i https://hostname:9559/CSM/web/sessions/<\/code><\/p>\n\t\t\t

          Benefits of Personal Access Tokens:<\/b><\/p>\n\t\t\t

          • No password exposure:<\/b> Tokens can be used instead of passwords in scripts and automation<\/li>
          • Granular control:<\/b> Each token can be individually revoked without affecting other tokens or the user's password<\/li>
          • Audit trail:<\/b> Token usage is logged with the token description for better tracking<\/li>
          • Long-lived:<\/b> Tokens don't expire unless explicitly set, eliminating the need for frequent re-authentication<\/li>
          • Easy management:<\/b> View, describe, and revoke tokens through the GUI<\/li><\/ul><\/p>\n\t\t\t

            Using Certificate Authentication<\/h2><\/p>\n\t\t\t

            Certificate-based authentication provides the highest level of security by using X.509 client certificates for mTLS authentication. This method is ideal for machine-to-machine communication and environments requiring strong authentication.<\/p>\n\t\t\t

            Creating a Client Certificate<\/h3>Client certificates must be created through the Copy Services Manager GUI:<\/p>\n\t\t\t

            1. Log in to the CSM GUI with your username and password<\/li>
            2. Click on your username in the top right corner<\/li>
            3. Select Manage Authentication<\/b> from the dropdown menu<\/li>
            4. Click Manage Certificates<\/b><\/li>
            5. Then click the button to generate a certificate. <\/li>
            6. Optionally set an expiration date<\/li>
            7. Click Generate<\/b><\/li>
            8. Download the client certificate file (.pem)<\/li>
            9. Store the certificate file securely<\/li><\/ol><\/p>\n\t\t\t

              Using Certificate authentication when calling the server<\/h3>Send the certificate in the X-Client-Certificate<\/code> header: (NOTE: --cert support will be available in a future release)<\/p>\n\t\t\t

              Example curl command using certificate authentication.<\/br>CERT=$(cat /path/to/certificate.pem)<\/code><\/br>curl -k -H \"X-Client-Certificate: $CERT\" https://hostname:9559/CSM/web/sessions/<\/code><\/p>\n\t\t\t

              Benefits of Certificate Authentication:<\/b><\/p>\n\t\t\t

              • Strongest security:<\/b> Uses public key cryptography for authentication<\/li>
              • No password required:<\/b> Certificates authenticate without exposing credentials<\/li>
              • Machine-to-machine:<\/b> Ideal for automated systems and service accounts<\/li>
              • No server configuration:<\/b> Works immediately without additional setup<\/li>
              • Revocable:<\/b> Certificates can be individually revoked through the GUI<\/li><\/ul><\/p>\n\t <\/div>", "version" : "6.3.x", "title" : "IBM Copy Services Manager - Server" }, "servers" : [ { "url" : "/" } ], "tags" : [ { "name" : "HardwareService" } , { "name" : "SessionService" } , { "name" : "SystemService" } ], "components" : { "schemas" : { } }, "paths": { "\/sessions" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                getSessionOverviews<\/h2>\nThis method returns the overview summary information for all sessions managed by the server\n\n

                Example curl:<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: e6bd5324sdf61b8fe4d513dsd8bd15f6' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/sessions<\/code>\n\n

                Principal JSON keys returned in response <\/h3>\n
                  \n
                1. name<\/b> - The name of the session <\/li>\n
                2. state<\/b> - The current state of the session <\/li>\n
                3. status<\/b> - The current status of the session <\/li>\n
                4. rulesname<\/b> - The type of session<\/li>\n
                5. productionhost<\/b> - The current production host volume<\/li>\n
                6. description<\/b> - The description given to the session by the user<\/li>\n
                7. recoverable<\/b> - Whether the session is currently recoverable<\/li>\n
                8. hyperswapstatus<\/b> - The current status for HyperSwap functionality if applicable<\/li>\n
                9. numcopysets<\/b> - The number of copy sets in the session<\/li>\n
                10. copying<\/b> - Whether the session is currently shadowoing<\/li>\n
                11. numvolumespercopyest<\/b> - The number of volumes that make up each copy set<\/li>\n<\/ol>", "operationId" : "getSessions", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the summary information for each session managed by the server\nSample of Output for a single session\nNOTE: Not all returned keys are shown here\n[\n{\"name\": \"8kGM\",\n\"state\": \"Defined\",,\n\"status\": \"Inactive\",\n\"productionhost\": \"H1\",\n\"rulesname\": \"Global Mirror Failover/Failback\",\n\"description\": \"\",\n\"recoverable\": false,\n\"sites\": [\n{\"roles\": [\"H1\"],\"name\": \"Site 1\",\"locations\": {}},\n{\"roles\": [\"H2\",\"J2\"],\"name\": \"Site 2\",\"locations\": {}}],\n\"hyperswapstatus\": \"off\",\n\"numcopysets\": 2,\n\"copying\": false,\n\"numvolumespercopyset\": 3,\n\"group\": \"\"}]<\/code>" } }, "parameters" : [ ] } }, "\/sessions/byvolgroup" : { "put" : { "tags" : [ "SessionService" ], "description" : "

                  createSessionByVolGroup<\/h2>\nCreate a copy services manager session and automatically creates a session name and populates the session based on the passed in volume group\n\n

                  Example curl:<\/h3>\n curl -X PUT -k -H 'X-Auth-Token: e6bd510f2032461b8fe4d513d8bd15f6' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/byvolgroup --data 'volgroup=STORAGE-VIRTUALIZE:VOLGROUP:FAB2-PROD1:mySnapGroup&type=SnapshotSVC&description=mydescr'<\/code>", "operationId" : "createSessionByVolGroup", "requestBody" : { "required" : false, "content" : { "application/x-www-form-urlencoded" : { "examples" : { "example" : { "value" : "description=...&type=...&volgroup=..." } }, "schema" : { "type" : "object", "title" : "null Data", "properties" : { "description" : { "readOnly" : false, "description" : "Optional description for the session", "type" : "string" }, "type" : { "readOnly" : false, "description" : "The type of session to create. Only Spec V Snapshot supports this today. Type is the \"shortname\" for the copy type returned in the /system/sessiontypes query.", "type" : "string" }, "volgroup" : { "readOnly" : false, "description" : "The name of the specv volume group that will be created", "type" : "string" } }, "description" : "

                  createSessionByVolGroup<\/h2>\nCreate a copy services manager session and automatically creates a session name and populates the session based on the passed in volume group\n\n

                  Example curl:<\/h3>\n curl -X PUT -k -H 'X-Auth-Token: e6bd510f2032461b8fe4d513d8bd15f6' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/byvolgroup --data 'volgroup=STORAGE-VIRTUALIZE:VOLGROUP:FAB2-PROD1:mySnapGroup&type=SnapshotSVC&description=mydescr'<\/code>" } } } }, "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nSample result\n{\"msg\":\"IWNR1021I\",\"inserts\":[\"MyFCSess\"],\"msgTranslated\":\"IWNR1021I [Apr 13, 2020 3:23:14 PM] Session MyFCSess was successfully created.\",\"timestamp\":1586809394287}<\/code>" } }, "parameters" : [ ] } }, "\/sessions/scheduledtasks" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                  getTasks<\/h2>\nReturns a list of scheduled tasks defined on the server\n\n

                  Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 016cda2d09cc49c2b28ae264426c38ef' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/scheduledtasks<\/code>", "operationId" : "getTasks", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\n
                    \n
                  1. id<\/b> ID for the task<\/li>\n
                  2. running<\/b> True if the task is currently running.<\/li>\n
                  3. affectedSession<\/b> List of sessions used in the scheduled task.<\/li>\n
                  4. name<\/b> Name for the scheduled task.<\/li>\n
                  5. actions<\/b> List of actions defined by the scheduled task.<\/li>\n<\/ol>\nSample result\n[{\"msg\":\"IWNR2205I\",\n\"resultText\":\"IWNR2205I [May 5, 2020 1:55:43 PM] The scheduled task 8kgm stop and start information retrieved.\",\n\"affectedSession\":[\"8kGM\"],\n\"description\":\"\",\n\"enabled\":false,\n\"pendingApproval\":false,\n\"nextRun\":null,\n\"running\":false,\n\"schedule\":{\"type\":\"NoTaskSchedule\"},\n\"name\":\"8kgm stop and start\",\n\"lastRan\":1588616632725,\n\"messages\":[{\"msg\":\"IWNR2200I\",\"resultText\":\"\",\"baseDate\":1588616624193,\"inserts\":[\"8kgm stop and start\"],\"resultType\":0},{\"msg\":\"IWNR2211I\",\"resultText\":\"\",\"baseDate\":1588616632725,\"inserts\":[\"8kgm stop and start\"],\"resultType\":0},{\"msg\":\"IWNR1026I\",\"resultText\":\"\",\"baseDate\":1588616633689,\"inserts\":[\"Suspend\",\"8kGM\"],\"resultType\":0},{\"msg\":\"IWNR2220I\",\"resultText\":\"\",\"baseDate\":1588616661786,\"inserts\":[\"8kgm stop and start\",\"2\",\"8kGM\",\"Suspended\",\"0\"],\"resultType\":0},{\"msg\":\"IWNR1026I\",\"resultText\":\"\",\"baseDate\":1588616663109,\"inserts\":[\"Start H1->H2\",\"8kGM\"],\"resultType\":0},{\"msg\":\"IWNR2226E\",\"resultText\":\"\",\"baseDate\":1588616663111,\"inserts\":[\"8kgm stop and start\",\"4\",\"8kGM\",\"H1-J2\"],\"resultType\":2},{\"msg\":\"IWNR2219E\",\"resultText\":\"\",\"baseDate\":1588616663112,\"inserts\":[\"8kgm stop and start\"],\"resultType\":2}],\n\"id\":16,\n\"logOnFailure\":false,\n\"inserts\":[\"8kgm stop and start\"],\n\"actions\":[\n{\"sessionName\":\"8kGM\",\"command\":\"Suspend\"},\n{\"sessionName\":\"8kGM\",\"state\":\"Suspended\",\"timeout\":180000},\n{\"sessionName\":\"8kGM\",\"command\":\"Start H1->H2\"},\n{\"sessionName\":\"8kGM\",\"rolePair\":\"H1-J2\",\"percentComplete\":100,\"timeout\":300000}],\n\"timestamp\":1588704943170},\n{\"msg\":\"IWNR2205I\",\"resultText\":\"IWNR2205I [May 5, 2020 1:55:43 PM] The scheduled task BackupSGC1 information retrieved.\",\n\"affectedSession\":[\"SGC\"],\n\"description\":\"\",\n\"enabled\":false,\n\"pendingApproval\":false,\n\"nextRun\":1581959700000,\n\"running\":false,\n\"schedule\":{\"interval\":1800000,\"type\":\"IntervalTaskSchedule\"},\n\"name\":\"BackupSGC1\",\"lastRan\":1588261695304,\n\"messages\":[{\"msg\":\"IWNR2211I\",\"resultText\":\"\",\"baseDate\":1588261695304,\"inserts\":[\"BackupSGC1\"],\"resultType\":0},{\"msg\":\"IWNR1026I\",\"resultText\":\"\",\"baseDate\":1588261700509,\"inserts\":[\"Backup\",\"SGC\"],\"resultType\":0},{\"msg\":\"IWNR2212I\",\"resultText\":\"\",\"baseDate\":1588261700511,\"inserts\":[\"BackupSGC1\"],\"resultType\":0}],\n\"id\":12,\n\"logOnFailure\":false,\n\"inserts\":[\"BackupSGC1\"],\n\"actions\":[\n{\"sessionName\":\"SGC\",\"command\":\"Backup\"}],\n\"timestamp\":1588704943169}],\n\"timestamp\":1588704943170}]<\/code>" } }, "parameters" : [ ] } }, "\/sessions/scheduledtasks/cancel/{taskid}" : { "post" : { "tags" : [ "SessionService" ], "description" : "

                    cancelTask<\/h2>\nCancel a running scheduled task.\n\n

                    Example curl<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: 016cda2d09cc49c2b28ae264426c38ef' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/scheduledtasks/cancel/12<\/code>", "operationId" : "cancelTask", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nSample result\n{\"msg\":\"IWNR2210I\",\"inserts\":[\"BackupSGC1\"],\"msgTranslated\":\"IWNR2210I [May 5, 2020 2:10:27 PM] The scheduled task Backup SGC was canceled.\",\"timestamp\":1588705827058}<\/code>" } }, "parameters" : [ { "name" : "taskid", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "ID of the schedule task to cancel" } ] } }, "\/sessions/scheduledtasks/create" : { "put" : { "tags" : [ "SessionService" ], "description" : "

                    createTask<\/h2>\nCreates a scheduled task off a json string that is given by the user.\n\nThe Scheduled task is input as a json String Form Param.\n\nThe data field should contain a json string with values such as the following:\n
                      \n
                    1. name<\/b>: user defined name of the task <\/li>\n
                    2. description<\/b>: user defined description for the task<\/li>\n
                    3. schedule<\/b>: json string indicating the schedule for the task (ex. “schedule”:{“days”:[“TUESDAY”,“WEDNESDAY”],“timeUTC”:1697734800189,“type”:“WeeklyTaskSchedule”,“timeOfDay”:{“hour”:12,“nano”:0,“minute”:0,“second”:0}}<\/li>\n
                    4. actions<\/b>: list of one of more actions the task will perform<\/li>\n
                    5. runOnEvent<\/b>: whether to run the task based on an event<\/li>\n
                    6. onEvents<\/b>: which events<\/li>\n
                    7. runtaskonfailure<\/b>: which task if any to run if there is a failure<\/li>\n
                    8. runtaskonsuccess<\/b>: which task if any to run if successful<\/li>\n
                    9. runtaskonsuccess<\/b>: whether to create a log package on a failure<\/li>\n\n<\/ol>\n\nFor more details on the format of the values you can create a scheduled task with similar parameters and perform and call GET .../sessions/scheduledtasks/{id}\n\n

                      Example curl<\/h3>\ncurl --location --request PUT ‘https://localhost:9559/CSM/web/sessions/scheduledtasks/create’ --header ‘Content-Type: application/x-www-form-urlencoded’ --data-urlencode 'json={\"description\": \"\",\t\"schedule\": { \"type\": \"WeekendHolidaySchedule\", \"startOrEnd\": \"start\", \"offsetHours\": 0,\"holidays\": [ { \"name\": \"Weekends\", \"type\": \"weekend\", \"month\": \"all\", \"start_of_weekend\": \"Saturday\", \"end_of_weekend\": \"Sunday\" }, { \"name\": \"New Years\", \"type\": \"fixed\", \"month\": \"January\", \"day_of_month\": 1 }, { \"name\": \"Martin Luther King, Jr.\", \"type\": \"calculated_by_day\", \"month\": \"January\", \"day_of_week\": \"Monday\", \"which\": \"third\" }, { \"name\": \"Presidents'\\'' Day\", \"type\": \"calculated_by_day\", \"month\": \"February\", \"day_of_week\": \"Monday\", \"which\": \"third\" }, { \"name\": \"Good Friday\", \"type\": \"varies\", }, { \"name\": \"Memorial Day\", \"type\": \"calculated_by_day\", \"month\": \"May\", \"day_of_week\": \"Monday\", \"which\": \"last\" }, { \"name\": \"Juneteenth\", \"type\": \"fixed\", \"month\": \"June\", \"day_of_month\": 19 }, { \"name\": \"Independence Day\", \"type\": \"fixed\", \"month\": \"July\", \"day_of_month\": 4 }, { \"name\": \"Labor Day\", \"type\": \"calculated_by_day\", \"month\": \"September\", \"day_of_week\": \"Monday\", \"which\": \"first\" }, { \"name\": \"Columbus Day\", \"type\": \"calculated_by_day\", \"month\": \"October\", \"day_of_week\": \"Monday\", \"which\": \"second\" },{ \"name\": \"Veterans Day\", \"type\": \"fixed\", \"month\": \"November\", \"day_of_month\": 11 }, { \"name\": \"Thanksgiving Day\", \"type\": \"calculated_by_day\", \"month\": \"November\", \"day_of_week\": \"Thursday\", \"which\": \"fourth\" }, { \"name\": \"Christmas Day\", \"type\": \"fixed\", \"month\": \"December\", \"day_of_month\": 25 } ] },\t\"runOnEvent\": {\"sessions\":[], \"onEvents\":[]\t\t},\t\"runtaskonfailure\": 0,\t\"name\": \"test run on for threat detection \",\t\"logOnFailure\": false,\t\"runtaskonsuccess\": 0,\t\"actions\": [\t\t{\t\t\t\"session\": \"Migration\",\t \"sessiontype\": \"Migration\",\t\t\"step\": 1,\t\t\t\"type\": \"Command Scheduled Action Option\",\t\t\t\"command\": \"StartGC H1->H2 with NoCopy\"\t\t}\t]}' <\/code>", "operationId" : "createTask", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ ] } }, "\/sessions/scheduledtasks/delete/{taskid}" : { "post" : { "tags" : [ "SessionService" ], "description" : "

                      deleteTask<\/h2>\nDelete a scheduled task.\n\n

                      Example curl<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: 016cda2d09cc49c2b28ae264426c38ef' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/scheduledtasks/delete/12<\/code>", "operationId" : "deleteTask", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nSample result\n{\"msg\":\"IWNR2210I\",\"inserts\":[\"BackupSGC1\"],\"msgTranslated\":\"IWNR2210I [May 5, 2020 2:10:27 PM] The scheduled task Backup SGC was deleted.\",\"timestamp\":1588705827058}<\/code>" } }, "parameters" : [ { "name" : "taskid", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "ID of the schedule task to delete" } ] } }, "\/sessions/scheduledtasks/disable/{taskid}" : { "post" : { "tags" : [ "SessionService" ], "description" : "

                      disableTask<\/h2>\nDisable a scheduled task.\n\n

                      Example curl<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: 016cda2d09cc49c2b28ae264426c38ef' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/scheduledtasks/disable/12<\/code>", "operationId" : "disableTask", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nSample result\n{\"msg\":\"IWNR2210I\",\"inserts\":[\"BackupSGC1\"],\"msgTranslated\":\"IWNR2210I [May 5, 2020 2:10:27 PM] The scheduled task Backup SGC was disabled.\",\"timestamp\":1588705827058}<\/code>" } }, "parameters" : [ { "name" : "taskid", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "ID of the schedule task to disable" } ] } }, "\/sessions/scheduledtasks/duplicate/{taskid}" : { "put" : { "tags" : [ "SessionService" ], "description" : "

                      duplicateTask<\/h2>\nDuplicates a schedule task of a given id and names the task of the given name.\n\n

                      Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: 016cda2d09cc49c2b28ae264426c38ef' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/scheduledtasks/duplicate/10<\/code>", "operationId" : "duplicateTask", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error as well as the detailed json representing the task including values such as:\n
                        \n
                      1. id<\/b> ID for the task<\/li>\n
                      2. running<\/b> True if the task is currently running.<\/li>\n
                      3. affectedSession<\/b> List of sessions used in the scheduled task.<\/li>\n
                      4. name<\/b> Name for the scheduled task.<\/li>\n
                      5. actions<\/b> List of actions defined by the scheduled task.<\/li>\n<\/ol>\n\n

                        Sample result:<\/h3>\n{\n\"msg\": \"IWNR2200I\",\n\"resultText\": \"IWNR2200I [Dec 13, 2023, 12:44:04 PM] The scheduled task get hostname_duplicate was created successfully.\",\n\"affectedSession\": [],\n\"description\": \"\",\n\"enabled\": false,\n\"pendingApproval\": false,\n\"nextRun\": null,\n\"running\": false,\n\"schedule\": {\n\"type\": \"NoTaskSchedule\"\n},\n\"runtaskonfailure\": 0,\n\"name\": \"get hostname_duplicate\",\n\"lastRan\": null,\n\"id\": 45,\n\"logOnFailure\": false,\n\"runtaskonsuccess\": 0,\n\"inserts\": [\n\"get hostname_duplicate\"\n],\n\"actions\": [\n{\n\"hostname\": \"amador1.storage.tucson.ibm.com\",\n\"port\": 22,\n\"successString\": \"\",\n\"session\": \"\",\n\"scriptCmd\": \"hostname\",\n\"step\": 1,\n\"type\": \"Run External Script Action Option\",\n\"userid\": \"root\",\n\"timeout\": 300000\n}\n],\n\"timestamp\": 1702493044672\n}" } }, "parameters" : [ { "name" : "taskid", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "the specified id for a scheduled task." } ] } }, "\/sessions/scheduledtasks/enable/{taskid}" : { "post" : { "tags" : [ "SessionService" ], "description" : "

                        enableTask<\/h2>\nEnable a scheduled task to run based off the schedule defined on the task.\n\n

                        Example curl<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: 016cda2d09cc49c2b28ae264426c38ef' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/scheduledtasks/enable/12<\/code>", "operationId" : "enableTask", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nSample result\n{\"msg\":\"IWNR2209I\",\"inserts\":[\"BackupSGC1\"],\"msgTranslated\":\"IWNR2209I [May 5, 2020 2:10:27 PM] The scheduled task Backup SGC was enabled.\",\"timestamp\":1588705827058}<\/code>" } }, "parameters" : [ { "name" : "taskid", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "ID of the schedule task to enable" } ] } }, "\/sessions/scheduledtasks/enable/{taskid}/{starttime}" : { "post" : { "tags" : [ "SessionService" ], "description" : "

                        enableTaskAtTime<\/h2>\nEnable a scheduled task to start running at the specified time.\n\n

                        Example curl<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: 016cda2d09cc49c2b28ae264426c38ef' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/scheduledtasks/enable/12/2021-03-12T14-54<\/code>", "operationId" : "enableTask2", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nSample result\n{\"msg\":\"IWNR2209I\",\"inserts\":[\"BackupSGC1\"],\"msgTranslated\":\"IWNR2209I [May 5, 2020 2:10:27 PM] The scheduled task Backup SGC was enabled.\",\"timestamp\":1588705827058}<\/code>" } }, "parameters" : [ { "name" : "starttime", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Time to enable the task. Format of yyyy-MM-dd'T'HH-mm." }, { "name" : "taskid", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "ID of the schedule task to enable" } ] } }, "\/sessions/scheduledtasks/{taskid}" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                        getTask<\/h2>\nReturns a list of scheduled tasks defined on the server\n\n

                        Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 016cda2d09cc49c2b28ae264426c38ef' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/scheduledtasks/4<\/code>", "operationId" : "getTask", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\n
                          \n
                        1. id<\/b> ID for the task<\/li>\n
                        2. running<\/b> True if the task is currently running.<\/li>\n
                        3. affectedSession<\/b> List of sessions used in the scheduled task.<\/li>\n
                        4. name<\/b> Name for the scheduled task.<\/li>\n
                        5. actions<\/b> List of actions defined by the scheduled task.<\/li>\n<\/ol>\nSample result\n[{\"msg\":\"IWNR2205I\",\n\"resultText\":\"IWNR2205I [May 5, 2020 1:55:43 PM] The scheduled task 8kgm stop and start information retrieved.\",\n\"affectedSession\":[\"8kGM\"],\n\"description\":\"\",\n\"enabled\":false,\n\"pendingApproval\":false,\n\"nextRun\":null,\n\"running\":false,\n\"schedule\":{\"type\":\"NoTaskSchedule\"},\n\"name\":\"8kgm stop and start\",\n\"lastRan\":1588616632725,\n\"messages\":[{\"msg\":\"IWNR2200I\",\"resultText\":\"\",\"baseDate\":1588616624193,\"inserts\":[\"8kgm stop and start\"],\"resultType\":0},{\"msg\":\"IWNR2211I\",\"resultText\":\"\",\"baseDate\":1588616632725,\"inserts\":[\"8kgm stop and start\"],\"resultType\":0},{\"msg\":\"IWNR1026I\",\"resultText\":\"\",\"baseDate\":1588616633689,\"inserts\":[\"Suspend\",\"8kGM\"],\"resultType\":0},{\"msg\":\"IWNR2220I\",\"resultText\":\"\",\"baseDate\":1588616661786,\"inserts\":[\"8kgm stop and start\",\"2\",\"8kGM\",\"Suspended\",\"0\"],\"resultType\":0},{\"msg\":\"IWNR1026I\",\"resultText\":\"\",\"baseDate\":1588616663109,\"inserts\":[\"Start H1->H2\",\"8kGM\"],\"resultType\":0},{\"msg\":\"IWNR2226E\",\"resultText\":\"\",\"baseDate\":1588616663111,\"inserts\":[\"8kgm stop and start\",\"4\",\"8kGM\",\"H1-J2\"],\"resultType\":2},{\"msg\":\"IWNR2219E\",\"resultText\":\"\",\"baseDate\":1588616663112,\"inserts\":[\"8kgm stop and start\"],\"resultType\":2}],\n\"id\":16,\n\"logOnFailure\":false,\n\"inserts\":[\"8kgm stop and start\"],\n\"actions\":[\n{\"sessionName\":\"8kGM\",\"command\":\"Suspend\"},\n{\"sessionName\":\"8kGM\",\"state\":\"Suspended\",\"timeout\":180000},\n{\"sessionName\":\"8kGM\",\"command\":\"Start H1->H2\"},\n{\"sessionName\":\"8kGM\",\"rolePair\":\"H1-J2\",\"percentComplete\":100,\"timeout\":300000}],\n\"timestamp\":1588704943170}]<\/code>" } }, "parameters" : [ { "name" : "taskid", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "the specified id for a scheduled task." } ] }, "post" : { "tags" : [ "SessionService" ], "description" : "

                          runTaskNow<\/h2>\nRun a scheduled task immediately.\n\n

                          Example curl<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: 016cda2d09cc49c2b28ae264426c38ef' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/scheduledtasks/12<\/code>", "operationId" : "runTaskNow", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nSample result\n{\"msg\":\"IWNR2208I\",\"inserts\":[\"BackupSGC1\"],\"msgTranslated\":\"IWNR2208I [May 5, 2020 2:10:27 PM] Forcing the scheduled task BackupSGC1 to run now.\",\"timestamp\":1588705827058}<\/code>" } }, "parameters" : [ { "name" : "taskid", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "ID of the schedule task to run" } ] } }, "\/sessions/scheduledtasks/{taskid}/runat/{starttime}" : { "post" : { "tags" : [ "SessionService" ], "description" : "

                          runTaskAtTime<\/h2>\nRun a scheduled task immediately.\n\n

                          Example curl<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: 016cda2d09cc49c2b28ae264426c38ef' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/scheduledtasks/12/runat/2021-03-12T14-54<\/code>", "operationId" : "runTaskAtTime", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nSample result\n{\"msg\":\"IWNR2208I\",\"inserts\":[\"BackupSGC1\"],\"msgTranslated\":\"IWNR2208I [May 5, 2020 2:10:27 PM] Forcing the scheduled task BackupSGC1 to run now.\",\"timestamp\":1588705827058}<\/code>" } }, "parameters" : [ { "name" : "starttime", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Time to run the task once. Format of yyyy-MM-dd'T'HH-mm." }, { "name" : "taskid", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "ID of the schedule task to run" } ] } }, "\/sessions/scheduledtasks/{taskid}/step/{step}" : { "post" : { "tags" : [ "SessionService" ], "description" : "

                          runTaskNow<\/h2>\nRun a scheduled task immediately.\n\n

                          Example curl<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: 016cda2d09cc49c2b28ae264426c38ef' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/scheduledtasks/12<\/code>", "operationId" : "runTaskNow2", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nSample result\n{\"msg\":\"IWNR2208I\",\"inserts\":[\"BackupSGC1\"],\"msgTranslated\":\"IWNR2208I [May 5, 2020 2:10:27 PM] Forcing the scheduled task BackupSGC1 to run now.\",\"timestamp\":1588705827058}<\/code>" } }, "parameters" : [ { "name" : "step", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "" }, { "name" : "taskid", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "ID of the schedule task to run" } ] } }, "\/sessions/scheduledtasks/{taskid}/{synchronous}" : { "post" : { "tags" : [ "SessionService" ], "description" : "

                          runTaskNow<\/h2>\nRun a scheduled task immediately.\n\n

                          Example curl<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: 016cda2d09cc49c2b28ae264426c38ef' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/scheduledtasks/12<\/code>", "operationId" : "runTaskNow3", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nSample result\n{\"msg\":\"IWNR2208I\",\"inserts\":[\"BackupSGC1\"],\"msgTranslated\":\"IWNR2208I [May 5, 2020 2:10:27 PM] Forcing the scheduled task BackupSGC1 to run now.\",\"timestamp\":1588705827058}<\/code>" } }, "parameters" : [ { "name" : "synchronous", "in" : "path", "required" : true, "schema" : { "type" : "boolean" }, "description" : "If true the result will not return until the task completes running. NOTE: this may take a long time, but would be good for scripting calls" }, { "name" : "taskid", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "ID of the schedule task to run" } ] } }, "\/sessions/scheduledtasks/{taskid}/{synchronous}/step/{step}" : { "post" : { "tags" : [ "SessionService" ], "description" : "

                          runTaskNow<\/h2>\nRun a scheduled task immediately.\n\n

                          Example curl<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: 016cda2d09cc49c2b28ae264426c38ef' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/scheduledtasks/12<\/code>", "operationId" : "runTaskNow4", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nSample result\n{\"msg\":\"IWNR2208I\",\"inserts\":[\"BackupSGC1\"],\"msgTranslated\":\"IWNR2208I [May 5, 2020 2:10:27 PM] Forcing the scheduled task BackupSGC1 to run now.\",\"timestamp\":1588705827058}<\/code>" } }, "parameters" : [ { "name" : "step", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "" }, { "name" : "synchronous", "in" : "path", "required" : true, "schema" : { "type" : "boolean" }, "description" : "If true the result will not return until the task completes running. NOTE: this may take a long time, but would be good for scripting calls" }, { "name" : "taskid", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "ID of the schedule task to run" } ] } }, "\/sessions/short" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                          getSessionOverviews<\/h2>\nThis method returns minimal overview summary information for all sessions managed by the server.\n\n

                          Example curl:<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: e6bd5324sdf61b8fe4d513dsd8bd15f6' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/sessions/short<\/code>", "operationId" : "getSessionsShort", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the summary information for each session managed by the server\nSample of Output for a single session\n[\n{\"numcopysets\": 0,\n\"productionhost\": \"H1\",\n\"haserror\": false,\n\"rulesname\": \"Metro Mirror Failover/Failback\",\n\"name\": \"GCsess\",\n\"copying\": false,\n\"description\": \"\",\n\"recoverable\": false,\n\"state\": \"Defined\",\n\"hyperswapstatus\": \"off\",\n\"status\": \"Inactive\"\n}]<\/code>" } }, "parameters" : [ ] } }, "\/sessions/short/volumegroup/{volgroup}" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                          getSessionsByVolumeGroupShort<\/h2>\nThis method returns shortened overview summary information for all sessions managed by the server which manage the volume group name passed in\n\n

                          Example curl:<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: e6bd5324sdf61b8fe4d513dsd8bd15f6' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/sessions/short/volumegroup/myvolgroup<\/code>", "operationId" : "getSessionsByVolumeGroupShort", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the summary information for each session managed by the server\nSample of Output for a single session\n[\n{\"numcopysets\": 0,\n\"productionhost\": \"H1\",\n\"haserror\": false,\n\"rulesname\": \"Metro Mirror Failover/Failback\",\n\"name\": \"GCsess\",\n\"copying\": false,\n\"description\": \"\",\n\"recoverable\": false,\n\"state\": \"Defined\",\n\"hyperswapstatus\": \"off\",\n\"status\": \"Inactive\"\n}]<\/code>" } }, "parameters" : [ { "name" : "volgroup", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" } ] } }, "\/sessions/volgroups" : { "put" : { "tags" : [ "SessionService" ], "description" : "

                          getVolGroups<\/h2>\nget all volume groups and their sessions, that is queried if given the volumegroup id or name. if neither are specified all volumegroups are shown.\n\n

                          Example curl: <\/h3>\ncurl -X POST -k -H 'X-Auth-Token: c8f5a3eb11e74c4badaa066f0a493a99' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/sessions/volgroups<\/code>\n

                          Example curl with specified volume group name: <\/h3>\ncurl -X POST -k -H 'Accept-Language: en-US,fr' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://hostname:9559/CSM/web/sessions/volgroups --data 'volGroupName=volgroup1'<\/code>", "operationId" : "getVolGroups", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ ] } }, "\/sessions/volumegroup/{volgroup}" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                          getSessionsByVolumeGroup<\/h2>\nThis method returns overview summary information for all sessions managed by the server which manage the volume group name passed in\n\n

                          Example curl:<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: e6bd5324sdf61b8fe4d513dsd8bd15f6' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/sessions/volumegroup/myvolgroup<\/code>", "operationId" : "getSessionsByVolumeGroup", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the summary information for each session managed by the server\nSample of Output for a single session\n[\n{\"numcopysets\": 0,\n\"productionhost\": \"H1\",\n\"haserror\": false,\n\"rulesname\": \"Metro Mirror Failover/Failback\",\n\"name\": \"GCsess\",\n\"copying\": false,\n\"description\": \"\",\n\"recoverable\": false,\n\"state\": \"Defined\",\n\"hyperswapstatus\": \"off\",\n\"status\": \"Inactive\"\n}]<\/code>" } }, "parameters" : [ { "name" : "volgroup", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" } ] } }, "\/sessions/{name}" : { "delete" : { "tags" : [ "SessionService" ], "description" : "

                          destroySession<\/h2>\nDeletes a copy services manager session. Only inactive sessions can be deleted.\n\n

                          Example curl:<\/h3>\n curl -X DELETE -k -H 'X-Auth-Token: c8f5a3eb11e74c4badaa066f0a493a99' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/sessions/MyFCSess <\/code>", "operationId" : "destroySession", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nSample result\n{\"msg\":\"IWNR1022I\",\"inserts\":[\"MyFCSess\"],\"msgTranslated\":\"IWNR1022I [Apr 13, 2020 4:20:16 PM] Session MyFCSess was successfully deleted.\",\"timestamp\":1586812816204}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session that will be deleted" } ] }, "get" : { "tags" : [ "SessionService" ], "description" : "

                          getSessionInfo<\/h2>\nThis method returns the detailed information for a given session\n\n

                          Example curl:<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: e6bd5324sdf61b8fe4d513dsd8bd15f6' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/sessions/8kGM<\/code>\n\n

                          Principal JSON keys returned in response <\/h3>\n
                            \n
                          1. name<\/b> - The name of the session <\/li>\n
                          2. state<\/b> - The current state of the session <\/li>\n
                          3. status<\/b> - The current status of the session <\/li>\n
                          4. rulesname<\/b> - The type of session<\/li>\n
                          5. productionhost<\/b> - The current production host volume<\/li>\n
                          6. description<\/b> - The description given to the session by the user<\/li>\n
                          7. recoverable<\/b> - Whether the session is currently recoverable<\/li>\n
                          8. hyperswapstatus<\/b> - The current status for HyperSwap functionality if applicable<\/li>\n
                          9. numcopysets<\/b> - The number of copy sets in the session<\/li>\n
                          10. copying<\/b> - Whether the session is currently shadowoing<\/li>\n
                          11. hwcg<\/b> - The name of the hardware consistency group if applicable<\/li>\n
                          12. numvolumespercopyest<\/b> - The number of volumes that make up each copy set<\/li>\n
                          13. sites<\/b> - List the site names that make up the session, and the roles that exist on each site<\/li>\n
                          14. group<\/b> - User defined group name for the session<\/li>\n
                          15. sessionprogress<\/b> - Replication progress for copying role pairs<\/li>\n
                          16. sequences<\/b> - Detailed information for each role pair in the session, including direction, hyperswap iosstate, copy type, number of errors, etc<\/li>\n
                          17. h1cg<\/b> - The name of the hardware consistency group at site 1 if applicable<\/li>\n
                          18. h2cg<\/b> - The name of the hardware consistency group at site 2 if applicable<\/li>\n
                          19. h1pool<\/b> - The name of the hardware pool at site 1 if applicable<\/li>\n
                          20. h2pool<\/b> - The name of the hardware pool at site 2 if applicable<\/li>\n<\/ol>", "operationId" : "getSessionInfo", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the detailed information for the session queried\nSample of Output for a single session\nNOTE: Not all returned keys are shown here\n{\"name\":\"8kGM\",\n\"state\":\"Defined\",,\n\"status\":\"Inactive\"\n\"rulesname\":\"Global Mirror Failover\\/Failback\",\n\"productionhost\":\"H1\",\n\"description\":\"\",\n\"recoverable\":false,\n\"hyperswapstatus\":\"off\",\n\"numcopysets\":2,\n\"copying\":false,,\n\"numvolumespercopyset\":3\n\"sites\":[\n{\"roles\":[\"H1\"],\"name\":\"Site 1\",\"locations\":{}},\n{\"roles\":[\"H2\",\"J2\"],\"name\":\"Site 2\",\"locations\":{}}],\n\"sequences\":[\n{\"seqname\":\"H1-H2\",\"numpairs\":2,\"numwarning\":0,\"numshadowing\":0,\"numrecoverable\":0,\"isShadowing\":false,\"iosstate\":\"TurnedOff\",\"exceptionNum\":0,\"baseCopyType\":\"GC\",\"isRecoverable\":false,\"progress\":null,\"direction\":true,\"timestamp\":\"n\\/a\"},\n{\"seqname\":\"H2-J2\",\"numpairs\":2,\"numwarning\":0,\"numshadowing\":0,\"numrecoverable\":0,\"isShadowing\":false,\"iosstate\":\"TurnedOff\",\"exceptionNum\":0,\"baseCopyType\":\"FC\",\"isRecoverable\":false,\"progress\":null,\"direction\":true,\"timestamp\":\"n\\/a\"},\n{\"seqname\":\"H1-J2\",\"numpairs\":2,\"numwarning\":0,\"numshadowing\":0,\"numrecoverable\":0,\"isShadowing\":false,\"iosstate\":\"TurnedOff\",\"exceptionNum\":0,\"baseCopyType\":\"GM\",\"isRecoverable\":false,\"progress\":null,\"direction\":true,\"timestamp\":\"n\\/a\"}],\n\"group\":\"\",\n\"sessionprogress\":[]}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Name of the session to query" } ] }, "post" : { "tags" : [ "SessionService" ], "description" : "

                            runSessionCmd<\/h2>\nRun a command against a session. Available commands for the session can be retrieved via the availablecommands API.\n\n

                            Example curl: <\/h3>\ncurl -X POST -k -H 'X-Auth-Token: c8f5a3eb11e74c4badaa066f0a493a99' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/sessions/SGC --data cmd=Backup<\/code>\n

                            Example curl with options (ie. Create a FlashSystems Safeguarded Snapshot with a Retention of x days): <\/h3>\ncurl -X POST -k -H 'Accept-Language: en-US,fr' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://hostname:9559/CSM/web/sessions/MyVolGroup --data 'cmd=Create Safeguarded Snapshot&options={\"type\":\"backupretention\",\"properties\":[{\"retention\":3}]}'<\/code>\n

                            Example curl with options (ie. Refresh a FlashSystems Thin Clone with a specified snapshot): <\/h3>\ncurl -X POST -k -H 'Accept-Language: en-US,fr' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://hostname:9559/CSM/web/sessions/MyVolGroup --data 'cmd=Refresh Thin Clone&options={\"type\":\"thincloneoptions\",\"properties\":\"[{'thinclone':'myvolumegroupname-0','snapshot':'csmSnapshot_1706904539',}]\"}'<\/code>\n

                            Example curl for Restore from Snapshot command specifying snapshot to restore from: <\/h3>\n curl --request POST --url https://hostname:9559/CSM/web/sessions/SNAP_csm_demo_FS52001 --H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' --data 'cmd=Restore From Snapshot&options={\"type\":\"thincloneoptions\",\"properties\":\"[{'\\''thinclone'\\'':null,'\\''snapshot'\\'':'\\''csmSnapshot_1772743334'\\'',}]\"}' <\/code>", "operationId" : "runSessionCmd", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nSample result\n{\"msg\":\"IWNR1026I\",\"inserts\":[\"Recover Backup\",\"SGC\"],\"results\":[],\"msgTranslated\":\"IWNR1026I [Apr 13, 2020 4:39:47 PM] The Recover Backup command in the SGC session completed.\",\"timestamp\":1586813987302}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session." } ] }, "put" : { "tags" : [ "SessionService" ], "description" : "

                            createSession<\/h2>\nCreate a copy services manager session. A session must be created before copy sets can be placed into the session and managed by the server.\n\n

                            Example curl:<\/h3>\n curl -X PUT -k -H 'X-Auth-Token: e6bd510f2032461b8fe4d513d8bd15f6' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/MyFCSess --data 'type=FC&description=My%20FC%20session'<\/code>", "operationId" : "createSession", "requestBody" : { "required" : false, "content" : { "application/x-www-form-urlencoded" : { "examples" : { "example" : { "value" : "description=...&type=..." } }, "schema" : { "type" : "object", "title" : "null Data", "properties" : { "description" : { "readOnly" : false, "description" : "Optional description for the session", "type" : "string" }, "type" : { "readOnly" : false, "description" : "The type of session to create. Type is the \"shortname\" for the copy type returned in the /system/sessiontypes query.", "type" : "string" } }, "description" : "

                            createSession<\/h2>\nCreate a copy services manager session. A session must be created before copy sets can be placed into the session and managed by the server.\n\n

                            Example curl:<\/h3>\n curl -X PUT -k -H 'X-Auth-Token: e6bd510f2032461b8fe4d513d8bd15f6' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/MyFCSess --data 'type=FC&description=My%20FC%20session'<\/code>" } } } }, "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nSample result\n{\"msg\":\"IWNR1021I\",\"inserts\":[\"MyFCSess\"],\"msgTranslated\":\"IWNR1021I [Apr 13, 2020 3:23:14 PM] Session MyFCSess was successfully created.\",\"timestamp\":1586809394287}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session that will be created" } ] } }, "\/sessions/{name}/association" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                            getSessionAssociations<\/h2>\nGets a list of session associated to this session\n\n

                            Example curl:<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: c8f5a3eb11e74c4badaa066f0a493a99' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/sessions/SGC/association <\/code>\n\n

                            Principal JSON keys returned in response <\/h3>\n
                              \n
                            1. sessionName<\/b> - The name of the session queried<\/li>\n
                            2. associated_session<\/b> - The name of the session associated to the session queried<\/li>\n
                            3. associated_rolepair<\/b> - The name of the role pair in the associated session tied to the session queried <\/li>\n
                            4. role<\/b> - The role in the session queried that is associated to the associated session<\/li>\n
                            5. matching_role<\/b> - The role in the associated session that is the same as the role in the session queried<\/li>\n
                            6. associated_action_role<\/b> - The role in the associated session that an action will be issued to<\/li>\n
                            7. action<\/b> - The actions such as RESTORE_TO_PROD that will a<\/li>\n<\/ol>", "operationId" : "getSessionAssociations", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON string listing out all session associations and the above info for each" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session to query" } ] } }, "\/sessions/{name}/association/restore_to_prod/{associated_sess}/{associated_rolepair}" : { "delete" : { "tags" : [ "SessionService" ], "description" : "

                              removeSessionAssociation<\/h2>\nRemoves association to another session and role pair to the passed in session\n\n

                              Example curl<\/h3>\ncurl -X DELETE -k -H 'X-Auth-Token: c91a8c7fa110490089f84d8454f6b403' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/SGC/association/MM/H1-H2<\/code>", "operationId" : "removeSessionAssociation", "responses" : { "204" : { "content" : { "*/*" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1093I\",\"inserts\":[\"SGC\",\"MM\",\"H1-H2\"],\"results\":[],\"msgTranslated\":\"IWNR1093I [Apr 24, 2020 4:47:51 PM] The session SGC was successfully associated to session MM and role pair H1-H2.\",\"timestamp\":1587764871881}<\/code>" } }, "parameters" : [ { "name" : "associated_rolepair", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The role pair in the associated session to be associated" }, { "name" : "associated_sess", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of session to associate with this session" }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session." } ] } }, "\/sessions/{name}/association/restore_to_prod/{associated_sess}/{associated_rolepair}/{role}/{matching_role}/{role_to_restore}" : { "post" : { "tags" : [ "SessionService" ], "description" : "

                              addOrUpdateSessionAssociation<\/h2>\nAssociation another session and role pair to the passed in session\n\n

                              Example curl<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: c91a8c7fa110490089f84d8454f6b403' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/SGC/association/restore_to_prod/MM/H1-H2/H1/H2/H1<\/code>", "operationId" : "addOrUpdateSessionAssociation", "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1093I\",\"inserts\":[\"SGC\",\"MM\",\"H1-H2\"],\"results\":[],\"msgTranslated\":\"IWNR1093I [Apr 24, 2020 4:47:51 PM] The session SGC was successfully associated to session MM and role pair H1-H2.\",\"timestamp\":1587764871881}<\/code>" } }, "parameters" : [ { "name" : "associated_rolepair", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The role pair in the associated session to be associated" }, { "name" : "associated_sess", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of session to associate with this session" }, { "name" : "matching_role", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the rol in the other session that matches the volumes in the role of the passed in session" }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session." }, { "name" : "role", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the role in this session" }, { "name" : "role_to_restore", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The role to restore in the associated session" } ] } }, "\/sessions/{name}/availablecommands" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                              getAvailableCommands<\/h2>\nReturns the list of available commands for a session based on the session's current state\n\n

                              Example curl:<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: c8f5a3eb11e74c4badaa066f0a493a99' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/8kFC/availablecommands<\/code>", "operationId" : "getAvailableCommands", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON string representing the list of commands that can be run using the runsessioncmd API\nExample output\n[\"Terminate\",\"Initiate Background Copy\",\"Flash\"]<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session." } ] } }, "\/sessions/{name}/backups/{role}/{backupid}" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                              getBackupDetails<\/h2>\nGets detailed information for a given backup in a session. Use getSessionInfo to get the list of backups in a session.\n\nProvides the following details\n
                                \n
                              1. backupID<\/b> ID for the given backup queried<\/li>\n
                              2. backupTime<\/b> The time the backup was taken<\/li>\n
                              3. isValid<\/b> Whether the backup is recoverable<\/li>\n
                              4. numCopySets<\/b> The number of volumes that were in this backup<\/li>\n
                              5. backupVolumes<\/b> A JSON list of volumes that were in the backup<\/li>\n
                              6. blockingExpansion<\/b> Whether one or more volumes cannot expand their backup capacity yet due to this backup<\/li>\n<\/ol>\n\n

                                Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 22dd90e234a6454eaa85201797f6d5d3' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/SGC/backups/H1/1587578175<\/code>", "operationId" : "getBackupDetails", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n\n{\"msg\":\"IWNR2800I\",\n\"resultText\":\"IWNR2800I [Apr 22, 2020 12:56:15 PM] A recoverable backup of all volumes in session SGC was created at 2020-04-22 12:56:15 CDT with an ID of 1587578175.\",\n\"numCopySets\":\"1\",\n\"backupID\":\"1587578175\",\n\"blockingExpansion\":\"false\",\n\"backupVolumes\":[\n{\"msg\":\"IWNR2819I\",\n\"resultText\":\"IWNR2819I [Apr 22, 2020 12:56:15 PM] A backup was created at 2020-04-22 12:56:15 CDT with an ID of 1587578175 for volume DS8000:2107.GXZ91:VOL:4005.\",\n\"volumeNickname\":\"DS8000:2107.GXZ91:VOL:4005\",\n\"volumeID\":\"DS8000:2107.GXZ91:VOL:4005\",\n\"inserts\":[\"2020-04-22 12:56:15 CDT\",\"1587578175\",\"DS8000:2107.GXZ91:VOL:4005\"],\n\"expansionBlocked\":\"false\",\n\"timestamp\":1587578175000}],\n\"isValid\":true,\n\"backupSeqName\":\"H1-B1\",\n\"backupTime\":\"2020-04-22 12:56:15 CDT\",\n\"inserts\":[\"SGC\",\"2020-04-22 12:56:15 CDT\",\"1587578175\"],\n\"timestamp\":1587578175000}<\/code>" } }, "parameters" : [ { "name" : "backupid", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "ID of the backup to get details for" }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "name of session" }, { "name" : "role", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "name of role where the backups reside (ex. \"H1\")" } ] }, "post" : { "tags" : [ "SessionService" ], "description" : "

                                runBackupIDSessionCmd<\/h2>\nRun a specified command that requires a backup ID parameter on a specified SGC session.\nFor example, \"Recover Backup\" or \"Expire Backup\" commands, with the backup ID parameter, would be given to the session using this method.\nTo obtain the available commands call getAvailableCommands\n\n

                                Example curl<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: c91a8c7fa110490089f84d8454f6b403' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/SGC/backups/H1/1587578524 --data 'cmd=Recover%20Backup'<\/code>", "operationId" : "runBackupIDSessionCmd", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1026I\",\"inserts\":[\"Recover Backup\",\"SGC\"],\"results\":[],\"msgTranslated\":\"IWNR1026I [Apr 24, 2020 4:47:51 PM] The Recover Backup command in the SGC session completed.\",\"timestamp\":1587764871881}<\/code>" } }, "parameters" : [ { "name" : "backupid", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "The ID of the backup to send to the run command" }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session." }, { "name" : "role", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of role where the backups reside" } ] } }, "\/sessions/{name}/checkcmd" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                checkCommand<\/h2>\nThis command will check the command entered and return one or more warning, etc. prompts for a user to confirm on prior to executing the command.\n\n

                                Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 180b08e4d54649eb840305d73b6dacbb' -H 'Content-Type: application/x-www-form-urlencoded' -i 'https://localhost:9559/CSM/web/sessions/MM/checkcmd?cmd=Terminate'<\/code>", "operationId" : "checkCommand", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1104I\",\"resultText\":\"IWNR1104I [Apr 21, 2020 4:55:39 PM] The command Terminate for session MM was checked successfully.\",\"cmdprompts\":[{\"msg\":\"IWNR1805W\",\"resultText\":\"IWNR1805W [Apr 21, 2020 4:55:39 PM] This command terminates all hardware relationships for the MM session. The target volumes will be unrecoverable. Data on Site 2 might not be usable. A Start command will require a full copy. Do you want to continue?\",\"type\":0,\"inserts\":[\"Site 2\",\"MM\"],\"timestamp\":1587506139660}],\"inserts\":[\"Terminate\",\"MM\"],\"timestamp\":1587506139660}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session" }, { "name" : "cmd", "in" : "query", "schema" : { "type" : "string" }, "description" : "The command to check" } ] } }, "\/sessions/{name}/checksnapgroupcmd" : { "post" : { "tags" : [ "SessionService" ], "description" : "

                                checkSnapGroupCommand<\/h2>\nThis command will check the snap group command entered and return one or more warning, etc. prompts for a user to confirm on prior to executing the command.", "operationId" : "checkSnapGroupCommand", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session" } ] } }, "\/sessions/{name}/clones" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                getSnapshotClones<\/h2>\nGets all thin clones for Spec V Snapshot session\n\n
                                  style=\"list-style-type:disc;\">\n
                                1. name<\/b> the name of the session to query\n<\/ol>\n\n

                                  Example curl<\/h3>\ncurl -X GET -k -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/sessions/csmguigrp1/clones/<\/code>", "operationId" : "getSnapshotThinClones", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "This is the session name." } ] } }, "\/sessions/{name}/clones/{thinclonename}" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                  getCloneDetailsByID<\/h2>\nGets the pair information for a specific clone on a specific session\n
                                    style=\"list-style-type:disc;\">\n
                                  1. name<\/b> the name of the session to query\n
                                  2. thinclonename<\/b> the name of the thin clone volume group to get the detailed info for\n<\/ol>\n\n

                                    Example curl<\/h3>\ncurl -X GET -k -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/sessions/csmguigrp1/clones/1619029157<\/code>", "operationId" : "getCloneDetails", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "This is the session name." }, { "name" : "thinclonename", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" } ] } }, "\/sessions/{name}/clonesBySnapshotName/{snapshotmame}" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                    getCloneDetailsByName<\/h2>\nGets the pair information for a specific clone on a specific session\n
                                      style=\"list-style-type:disc;\">\n
                                    1. name<\/b> the name of the session to query\n
                                    2. snapshotname<\/b> the name of the snapshot to get the detailed info for\n<\/ol>\n\n

                                      Example curl<\/h3>\ncurl -X GET -k -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/sessions/csmguigrp1/clonesBySnapshotName/snapshot1<\/code>", "operationId" : "getCloneDetailsByName", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "This is the session name." }, { "name" : "snapshotmame", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" } ] } }, "\/sessions/{name}/consolemessages/{count}" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                      getLastCommandResults<\/h2>\nRetrieves the latest console messages tied to the session passed in. Only the number of messages specified by count will be returned\n\n

                                      Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 8d72c750a81e429fa19cf6fd32d9f1ec' -H 'Content-Type: application/x-www-form-urlencoded' -i 'https://localhost:9559/CSM/web/sessions/8kGM/consolemessages/100'<\/code>", "operationId" : "getRecentSessionLogEvents", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1602I\",\"resultText\":\"IWNR1602I [Feb 17, 2022 12:48:17 PM] Successfully retrieved session messages.\",\"logevents\":[{\"resultText\":\"IWNR1026I [Feb 17, 2022 12:48:17 PM] The Start H1->H2 command in the 8kMM session completed.\",\"eventnumber\":1645123697499,\"eventfilter\":\"com.ibm.csm.common.events.LogEvent\",\"createddate\":1645123697499,\"session\":\"8kMM\",\"msgid\":\"IWNR1026I\",\"time\":\"Thu\nFeb 17 12:48:17 CST 2022\",\"id\":65204,\"user\":\"csmadmin\",\"msgtype\":0,\"inserts\":\" Start H1->H2 8kMM\",\"timestamp\":1645114585300},{\"resultText\":\"IWNR1950I [Feb 17, 2022 12:48:17 PM] Session 8kMM changed from the Defined state to the Prepared state.\",\"eventnumber\":1645123697499,\"eventfilter\":\"com.ibm.csm.common.events.LogEvent\",\"createddate\":1645123697499,\"session\":\"8kMM\",\"msgid\":\"IWNR1950I\",\"time\":\"Thu\nFeb 17 12:48:17 CST 2022\",\"id\":65203,\"user\":\"Server\",\"msgtype\":0,\"inserts\":\" 8kMM Defined Prepared\",\"timestamp\":1645114585299}],\"inserts\":[],\"timestamp\":1645123697499}<\/code>" } }, "parameters" : [ { "name" : "count", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The number of messages you wish to return. Specify 0 to return all messages for the session (NOTE: there could be a LOT of messages so we do not recommend you returning all messages)" }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session" } ] } }, "\/sessions/{name}/copysetmatches" : { "post" : { "tags" : [ "SessionService" ], "description" : "

                                      Not currently supported for external use<\/h2>", "operationId" : "getCopySetMatches", "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" } ] } }, "\/sessions/{name}/copysets" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                      getAllCopysets<\/h2>\nReturns all the copy sets and their volumes that exist in the session\n\n

                                      Example curl:<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 52299d68e11247af9628b3bef16c2723' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/sessions/8kGM/copysets<\/code>\n\n

                                      Principal JSON keys returned in response <\/h3>\n
                                        \n
                                      1. copysetid<\/b> - The ID used for the copy set<\/li>\n
                                      2. volumelist<\/b> - Denotes the start of the list of volumes that make up a copy set<\/li>\n
                                      3. elementid<\/b> - The ID for one of the volumes in the copy set<\/li>\n
                                      4. capacitytype<\/b> - The type that the capacity is defined in<\/li>\n
                                      5. capacity<\/b> - The capacity for a volume in the copy set, in the units defined by capacitytype<\/li>\n
                                      6. elementtype<\/b> - The type of volume in the copy setr<\/li>\n
                                      7. manufacturer<\/b> - The manufacturer for the volume<\/li>\n
                                      8. nickname<\/b> - The user defined name or volser for the volume<\/li>\n<\/ol>", "operationId" : "getAllCopysets", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON string listing out all pairs and details for those pairs within the given role pair\nExample output for a session with 1 copyset which has 3 volumes (not all returned fields are shown):\n[{\"volumelist\":\n[{\"elementid\":\"DS8000:2107.GXZ91:VOL:9000\",\n\"capacitytype\":\"Bytes\",\n\"capacity\":107374182400,\n\"elementtype\":\"FIXEDBLK\",\n\"manufacturer\":\"IBM\",\n\"nickname\":\"DS8000:2107.GXZ91:VOL:9000\",},\n{\"elementid\":\"DS8000:2107.GXZ91:VOL:9100\",\n\"capacitytype\":\"Bytes\",\n\"capacity\":107374182400,\n\"elementtype\":\"FIXEDBLK\",\n\"manufacturer\":\"IBM\",\n\"nickname\":\"DS8000:2107.GXZ91:VOL:9100\"},\n{\"elementid\":\"DS8000:2107.GXZ91:VOL:9200\",\n\"capacitytype\":\"Bytes\",\n\"capacity\":107374182400,\n\"elementtype\":\"FIXEDBLK\",\n\"manufacturer\":\"IBM\",\n\"nickname\":\"DS8000:2107.GXZ91:VOL:9200\"}]\n\"copysetid\":\"DS8000:2107.GXZ91:VOL:9000\"}]<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session." } ] }, "post" : { "tags" : [ "SessionService" ], "description" : "

                                        createCopysets<\/h2>\nAdd copy sets to a given session\n\n

                                        Example curl<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: e69d4e0f6eaa4d619669bf000db44e42' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/MM/copysets --data 'copysets=[[\"DS8000:2107.GXZ91:VOL:0001\",\"DS8000:2107.GXZ91:VOL:0101\"]]'<\/code>", "operationId" : "createCopysets", "requestBody" : { "required" : false, "content" : { "application/x-www-form-urlencoded" : { "examples" : { "example" : { "value" : "copysets=...&listenernumber=...&roleOrder=..." } }, "schema" : { "type" : "object", "title" : "null Data", "properties" : { "copysets" : { "readOnly" : false, "description" : "List of copy sets to add to the session in JSON format", "type" : "string" }, "listenernumber" : { "readOnly" : false, "description" : "Specify 0. Adding copy sets is a long running process. This field is for future use in providing status of the progress for the add", "type" : "string" }, "roleOrder" : { "readOnly" : false, "description" : "", "type" : "string" } }, "description" : "

                                        createCopysets<\/h2>\nAdd copy sets to a given session\n\n

                                        Example curl<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: e69d4e0f6eaa4d619669bf000db44e42' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/MM/copysets --data 'copysets=[[\"DS8000:2107.GXZ91:VOL:0001\",\"DS8000:2107.GXZ91:VOL:0101\"]]'<\/code>" } } } }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1000I\",\"inserts\":[\"MM\"],\"results\":[{\"msg\":\"IWNR2001I\",\"inserts\":[\"MM\",\"DS8000:2107.GXZ91:VOL:0001\",\"DS8000:2107.GXZ91:VOL:0001(CSM001)\",\"DS8000:2107.GXZ91:VOL:0101(CSM101)\",\"\",\"H1-H2\"],\"msgTranslated\":\"IWNR2001I [Apr 21, 2020 4:30:54 PM] The pair was created in session MM for copy set with a copy set ID of DS8000:2107.GXZ91:VOL:0001, with a source volume ID of DS8000:2107.GXZ91:VOL:0001(CSM001), and a target volume ID of DS8000:2107.GXZ91:VOL:0101(CSM101).\",\"timestamp\":1587504654149}],\"msgTranslated\":\"IWNR1000I [Apr 21, 2020 4:30:54 PM] Copy sets were created for the session named MM.\",\"timestamp\":1587504654149}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session." } ] } }, "\/sessions/{name}/copysets/download" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                        getAllCopysetsExportCSV<\/h2>\nThis method get all copysets for a session and export them to a csv file.\n\n

                                        Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: ebdd0df8e67c4317bac177967c3d1a7e' -H 'Content-Type: application/octet-stream' -i https://hostname:9559/CSM/web/sessions/8kGM/copysets/download --output copysets.csv <\/code>", "operationId" : "getAllCopysetsExportCSV", "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "byte[] containing the file in the form or a .csv file Use -o in curl to download the file." } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" } ] } }, "\/sessions/{name}/copysets/short" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                        getAllCopysetsShort<\/h2>\nReturns all the copy sets and their volumes that exist in the session, but with less volume information that the other query\n\n

                                        Example curl:<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 52299d68e11247af9628b3bef16c2723' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/sessions/8kGM/copysets/short<\/code>\n\n

                                        Principal JSON keys returned in response <\/h3>\n
                                          \n
                                        1. copysetid<\/b> - The ID used for the copy set<\/li>\n
                                        2. volumelist<\/b> - Denotes the start of the list of volumes that make up a copy set<\/li>\n
                                        3. elementid<\/b> - The ID for one of the volumes in the copy set<\/li>\n
                                        4. capacitytype<\/b> - The type that the capacity is defined in<\/li>\n
                                        5. capacity<\/b> - The capacity for a volume in the copy set, in the units defined by capacitytype<\/li>\n
                                        6. elementtype<\/b> - The type of volume in the copy setr<\/li>\n
                                        7. manufacturer<\/b> - The manufacturer for the volume<\/li>\n
                                        8. nickname<\/b> - The user defined name or volser for the volume<\/li>\n<\/ol>", "operationId" : "getAllCopysetsShort", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON string listing out all pairs and details for those pairs within the given role pair\nExample output for a session with 1 copyset which has 3 volumes (not all returned fields are shown):\n[{\"volumelist\":\n[{\"elementid\":\"DS8000:2107.GXZ91:VOL:9000\",\n\"capacitytype\":\"Bytes\",\n\"capacity\":107374182400,\n\"elementtype\":\"FIXEDBLK\",\n\"manufacturer\":\"IBM\",\n\"nickname\":\"DS8000:2107.GXZ91:VOL:9000\",},\n{\"elementid\":\"DS8000:2107.GXZ91:VOL:9100\",\n\"capacitytype\":\"Bytes\",\n\"capacity\":107374182400,\n\"elementtype\":\"FIXEDBLK\",\n\"manufacturer\":\"IBM\",\n\"nickname\":\"DS8000:2107.GXZ91:VOL:9100\"},\n{\"elementid\":\"DS8000:2107.GXZ91:VOL:9200\",\n\"capacitytype\":\"Bytes\",\n\"capacity\":107374182400,\n\"elementtype\":\"FIXEDBLK\",\n\"manufacturer\":\"IBM\",\n\"nickname\":\"DS8000:2107.GXZ91:VOL:9200\"}]\n\"copysetid\":\"DS8000:2107.GXZ91:VOL:9000\"}]<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session." } ] } }, "\/sessions/{name}/copysets/{devicename}" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                          Not currently supported for external use<\/h2>", "operationId" : "getSessionCopysetsByDevice", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "devicename", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" }, { "name" : "subsystemname", "in" : "query", "schema" : { "type" : "string" }, "description" : "" } ] } }, "\/sessions/{name}/copysets/{id}/pairs" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                          getPairInfoByCopyset<\/h2>\nGets all pairs and their info for a given copy set\n\n

                                          Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 8d72c750a81e429fa19cf6fd32d9f1ec' -H 'Content-Type: application/x-www-form-urlencoded' -i 'https://localhost:9559/CSM/web/sessions/8kGM/copysets/DS8000:2107.GXZ91:VOL:9000/pairs'<\/code>", "operationId" : "getPairInfoByCopyset", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\n[{\"sourceid\":\"DS8000:2107.GXZ91:VOL:9000\",\n\"isshadowing\":true,\n\"lastresult\":{\"msg\":\"IWNR2733I\",\"inserts\":[\"2107.GXZ91\",\"8kGM\"],\"timestamp\":1587592114476},\n\"targetid\":\"DS8000:2107.GXZ91:VOL:9200\",\n\"targetnickname\":\"DS8000:2107.GXZ91:VOL:9200\",\n\"pendingstate\":null,\n\"isnew\":false,\n\"isconsistent\":false,\n\"isrecoverable\":true,\n\"copyset\":\"DS8000:2107.GXZ91:VOL:9000\",\n\"state\":\"Prepared\",\n\"seqname\":\"H1-J2\",\n\"sourcenickname\":\"DS8000:2107.GXZ91:VOL:9000\",\n\"timestamp\":\"n\\/a\"},\n{\"sourceid\":\"DS8000:2107.GXZ91:VOL:9100\",\n\"isshadowing\":true,\n\"lastresult\":{\"msg\":\"IWNR2016I\",\"inserts\":[\"8kGM\",\"DS8000:2107.GXZ91:VOL:9000\",\"DS8000:2107.GXZ91:VOL:9100\",\"DS8000:2107.GXZ91:VOL:9200\",\"\",\"H2-J2\"],\"timestamp\":1587572980817},\n\"targetid\":\"DS8000:2107.GXZ91:VOL:9200\",\n\"targetnickname\":\"DS8000:2107.GXZ91:VOL:9200\",\n\"pendingstate\":null,\n\"isnew\":false,\n\"isconsistent\":false,\n\"isrecoverable\":false,\n\"copyset\":\"DS8000:2107.GXZ91:VOL:9000\",\n\"state\":\"Target Available\",\n\"seqname\":\"H2-J2\",\n\"sourcenickname\":\"DS8000:2107.GXZ91:VOL:9100\",\n\"timestamp\":\"n\\/a\"},\n{\"sourceid\":\"DS8000:2107.GXZ91:VOL:9000\",\n\"isshadowing\":true,\n\"lastresult\":{\"msg\":\"IWNR2011I\",\"inserts\":[\"8kGM\",\"DS8000:2107.GXZ91:VOL:9000\",\"DS8000:2107.GXZ91:VOL:9000\",\"DS8000:2107.GXZ91:VOL:9100\",\"\",\"H1-H2\"],\"timestamp\":1587572980817},\n\"targetid\":\"DS8000:2107.GXZ91:VOL:9100\",\n\"targetnickname\":\"DS8000:2107.GXZ91:VOL:9100\",\n\"pendingstate\":null,\n\"isnew\":true,\n\"isconsistent\":false,\n\"isrecoverable\":false,\n\"copyset\":\"DS8000:2107.GXZ91:VOL:9000\",\n\"state\":\"Preparing\",\n\"seqname\":\"H1-H2\",\n\"sourcenickname\":\"DS8000:2107.GXZ91:VOL:9000\",\n\"timestamp\":\"n\\/a\"}]<\/code>" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The id of the copyset." }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session." } ] } }, "\/sessions/{name}/description" : { "post" : { "tags" : [ "SessionService" ], "description" : "

                                          modifyDescription<\/h2>\nChanges the description field for a given session. Each session has a field available for a user defined description.\n\n

                                          Example curl:<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: c8f5a3eb11e74c4badaa066f0a493a99' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/sessions/8kGM/description --data 'description=testing%20modify%20description'<\/code>", "operationId" : "modifyDescription", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1124I\",\"inserts\":[\"8kGM\",\"testing modify description\"],\"msgTranslated\":\"IWNR1124I [Apr 13, 2020 5:30:01 PM] The description for session 8kGM was modified successfully. The new description is testing modify description.\",\"timestamp\":1586817001350}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session." } ] } }, "\/sessions/{name}/exporteseboxconstraints" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                          exportESEBoxConstraints<\/h2>\nGets a list of time frames for ESE box historical reporting data related to a given session.\nFor DS8000 this returns the earliest and most recent dates for ESE volume data\nNOTE: Dates returned in milliseconds since Jan 1, 1970\n\n

                                          Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 8d72c750a81e429fa19cf6fd32d9f1ec' -i https://localhost:9559/CSM/web/sessions/8kGM/exporteseboxconstraints<\/code>", "operationId" : "exportESEBoxConstraints", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1262I\",\n\"resultText\":\"IWNR1262I [Apr 22, 2020 3:07:20 PM] The data for session {1} was exported. The CSV file is located on the server at: {2}\",\n\"inserts\":[],\n\"constraints\":[\n{\"sequence\":\"H1-J2\",\"datatype\":\"rpo\",\"endtime\":1587531600000,\"starttime\":1587531600000},\n{\"sequence\":\"H1-J2\",\"datatype\":\"oos\",\"endtime\":1587531600000,\"starttime\":1587531600000}],\n\"timestamp\":1587586040118}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The session name." } ] } }, "\/sessions/{name}/exporteseboxhistory" : { "put" : { "tags" : [ "SessionService" ], "description" : "

                                          exportESEBoxHistory<\/h2>\nExport ESE Box History for a session in csv format to a file\nTo determine possible dates call exportrpoconstraints and look at the dates for datatype and convert the milliseconds returned into YYYY-MM-DD format\n\n

                                          Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: 8d72c750a81e429fa19cf6fd32d9f1ec' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/8kGM/exportrpohistory/H1-J2 --data 'starttime=2020-04-22&endtime=2020-04-22'<\/code>", "operationId" : "exportESEBoxHistory", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1262I\",\"resultText\":\"IWNR1262I [Apr 22, 2020 3:51:19 PM] The data for session 8kGM was exported. The CSV file is located on the server at: \\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/exportdir\\/8kGMH1-J2rpo2020-04-22-15-51-19.csv\",\"filename\":\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/exportdir\\/8kGMH1-J2rpo2020-04-22-15-51-19.csv\",\"lines\":236,\"inserts\":[\"8kGM\",\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/exportdir\\/8kGMH1-J2rpo2020-04-22-15-51-19.csv\"],\"timestamp\":1587588679818}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The session name." } ] } }, "\/sessions/{name}/exportesevolconstraints" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                          exportESEVolumeConstraints<\/h2>\nGets a list of time frames for ESE volume historical reporting data related to a given session.\nFor DS8000 this returns the earliest and most recent dates for ESE volume data\nNOTE: Dates returned in milliseconds since Jan 1, 1970\n\n

                                          Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 8d72c750a81e429fa19cf6fd32d9f1ec' -i https://localhost:9559/CSM/web/sessions/8kGM/exportesevolconstraints<\/code>", "operationId" : "exportESEVolumeConstraints", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1262I\",\n\"resultText\":\"IWNR1262I [Apr 22, 2020 3:07:20 PM] The data for session {1} was exported. The CSV file is located on the server at: {2}\",\n\"inserts\":[],\n\"constraints\":[\n{\"sequence\":\"H1-J2\",\"datatype\":\"rpo\",\"endtime\":1587531600000,\"starttime\":1587531600000},\n{\"sequence\":\"H1-J2\",\"datatype\":\"oos\",\"endtime\":1587531600000,\"starttime\":1587531600000}],\n\"timestamp\":1587586040118}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The session name." } ] } }, "\/sessions/{name}/exportesevolumehistory" : { "put" : { "tags" : [ "SessionService" ], "description" : "

                                          exportESEVolumeHistory<\/h2>\nExport ESE Box History for a session in csv format to a file\nTo determine possible dates call exportrpoconstraints and look at the dates for datatype and convert the milliseconds returned into YYYY-MM-DD format\n\n

                                          Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: 8d72c750a81e429fa19cf6fd32d9f1ec' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/8kGM/exportrpohistory/H1-J2 --data 'starttime=2020-04-22&endtime=2020-04-22'<\/code>", "operationId" : "exportESEVolumeHistory", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1262I\",\"resultText\":\"IWNR1262I [Apr 22, 2020 3:51:19 PM] The data for session 8kGM was exported. The CSV file is located on the server at: \\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/exportdir\\/8kGMH1-J2rpo2020-04-22-15-51-19.csv\",\"filename\":\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/exportdir\\/8kGMH1-J2rpo2020-04-22-15-51-19.csv\",\"lines\":236,\"inserts\":[\"8kGM\",\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/exportdir\\/8kGMH1-J2rpo2020-04-22-15-51-19.csv\"],\"timestamp\":1587588679818}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The session name." } ] } }, "\/sessions/{name}/exportlssooshistory/{seqname}" : { "put" : { "tags" : [ "SessionService" ], "description" : "

                                          exportlssooshistory<\/h2>\nExport LSS OOS History for a session in csv format to a file\nOnly DS8000 storage systems return OOS history.\nTo determine possible dates call exportrpoconstraints and look at the dates for datatype OOS and convert the milliseconds returned into YYYY-MM-DD format\n\n\n

                                          Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: 8d72c750a81e429fa19cf6fd32d9f1ec' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/8kGM/exportlssooshistory/H1-J2 --data 'starttime=2020-04-22&endtime=2020-04-22'<\/code>", "operationId" : "exportLSSOOSHistory", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1262I\",\"resultText\":\"IWNR1262I [Apr 22, 2020 3:40:36 PM] The data for session 8kGM was exported. The CSV file is located on the server at: \\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/exportdir\\/8kGMH1-J2lssoos2020-04-22-15-40-36.csv\",\"filename\":\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/exportdir\\/8kGMH1-J2lssoos2020-04-22-15-40-36.csv\",\"lines\":115,\"inserts\":[\"8kGM\",\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/exportdir\\/8kGMH1-J2lssoos2020-04-22-15-40-36.csv\"],\"timestamp\":1587588036939}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The session name." }, { "name" : "seqname", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The role pair name to query" } ] } }, "\/sessions/{name}/exportrpoconstraints" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                          exportRPOConstraints<\/h2>\nGets a list of time frames for GM historical reporting data related to a given session.\nFor DS8000 this returns the earliest and most recent dates for RPO data and LSS OOS data\nFor other storage systems this returns the earliest and most recent dates for RPO Data only\nNOTE: Dates returned in milliseconds since Jan 1, 1970\n\n

                                          Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 8d72c750a81e429fa19cf6fd32d9f1ec' -i https://localhost:9559/CSM/web/sessions/8kGM/exportrpoconstraints<\/code>", "operationId" : "exportRPOConstraints", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1262I\",\n\"resultText\":\"IWNR1262I [Apr 22, 2020 3:07:20 PM] The data for session {1} was exported. The CSV file is located on the server at: {2}\",\n\"inserts\":[],\n\"constraints\":[\n{\"sequence\":\"H1-J2\",\"datatype\":\"rpo\",\"endtime\":1587531600000,\"starttime\":1587531600000},\n{\"sequence\":\"H1-J2\",\"datatype\":\"oos\",\"endtime\":1587531600000,\"starttime\":1587531600000}],\n\"timestamp\":1587586040118}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The session name." } ] } }, "\/sessions/{name}/exportrpohistory/{seqname}" : { "put" : { "tags" : [ "SessionService" ], "description" : "

                                          exportRPOHistory<\/h2>\nExport RPO History for a session in csv format to a file\nTo determine possible dates call exportrpoconstraints and look at the dates for datatype OOS and convert the milliseconds returned into YYYY-MM-DD format\n\n

                                          Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: 8d72c750a81e429fa19cf6fd32d9f1ec' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/8kGM/exportrpohistory/H1-J2 --data 'starttime=2020-04-22&endtime=2020-04-22'<\/code>", "operationId" : "exportRPOHistory", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1262I\",\"resultText\":\"IWNR1262I [Apr 22, 2020 3:51:19 PM] The data for session 8kGM was exported. The CSV file is located on the server at: \\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/exportdir\\/8kGMH1-J2rpo2020-04-22-15-51-19.csv\",\"filename\":\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/exportdir\\/8kGMH1-J2rpo2020-04-22-15-51-19.csv\",\"lines\":236,\"inserts\":[\"8kGM\",\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/exportdir\\/8kGMH1-J2rpo2020-04-22-15-51-19.csv\"],\"timestamp\":1587588679818}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The session name." }, { "name" : "seqname", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The role pair name." } ] } }, "\/sessions/{name}/exportsgcrecommendation/{backups}" : { "put" : { "tags" : [ "SessionService" ], "description" : "

                                          exportSGCRecommendation<\/h2>\nExport ESE Box History for a session in csv format to a file\nTo determine possible dates call exportrpoconstraints and look at the dates for datatype and convert the milliseconds returned into YYYY-MM-DD format\n\n

                                          Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: 8d72c750a81e429fa19cf6fd32d9f1ec' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/SGCSizer/exportsgcrecommendation/3 --data 'starttime=2020-04-22&endtime=2020-04-22'<\/code>", "operationId" : "exportSGCRecommendation", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1262I\",\"resultText\":\"IWNR1262I [Apr 22, 2020 3:51:19 PM] The data for session 8kGM was exported. The CSV file is located on the server at: \\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/exportdir\\/8kGMH1-J2rpo2020-04-22-15-51-19.csv\",\"filename\":\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/exportdir\\/8kGMH1-J2rpo2020-04-22-15-51-19.csv\",\"lines\":236,\"inserts\":[\"8kGM\",\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/exportdir\\/8kGMH1-J2rpo2020-04-22-15-51-19.csv\"],\"timestamp\":1587588679818}<\/code>" } }, "parameters" : [ { "name" : "backups", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "number of backups per retention period to calculate" }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The session name." } ] } }, "\/sessions/{name}/exportsgcrecommendation/{backups}/download" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                          exportSGCRecommendationDownload<\/h2>\nThis method creates a sgc recommendation and downloads it", "operationId" : "exportSGCRecommendationDownload", "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "byte[] containing the file in the form or a .csv file Use -o in curl to download the file." } }, "parameters" : [ { "name" : "backups", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "number of backups per retention period to calculate\n\n

                                          Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: ebdd0df8e67c4317bac177967c3d1a7e' -H 'Content-Type: application/octet-stream' -i https://localhost:9559/CSM/web/sessions/SGCSizer/exportsgcrecommendation/3/download --output sgcrecommendation.csv <\/code>" }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The session name." } ] } }, "\/sessions/{name}/getlssooshistory/{seqname}" : { "put" : { "tags" : [ "SessionService" ], "description" : "

                                          getLSSOOSHistory<\/h2>\nGet LSS OOS History for a session in json format.\nOnly DS8000 storage systems return OOS history.\nTo determine possible dates call exportrpoconstraints and look at the dates for datatype OOS and convert the milliseconds returned into YYYY-MM-DD format\n\n

                                          Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: 8d72c750a81e429fa19cf6fd32d9f1ec' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/8kGM/getlssooshistory/H1-J2 --data 'starttime=2020-04-22&endtime=2020-04-22'<\/code>", "operationId" : "getLSSOOSHistory", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1284I\",\n\"resultText\":\"IWNR1284I [Apr 22, 2020 3:32:31 PM] The data for session 8kGM was retrieved.\",\n\"header\":[\"Query Time\",\"Hardware Time\",\"Interval\",\"Session Number\",\"Box Name\",\"LSS\",\"Out of Sync Tracks\"],\n\"lines\":[\n{\"Query Time\":1587573051951,\n\"Session Number\":\"0x5f\",\n\"Hardware Time\":1587576023000,\n\"LSS\":\"0x90\",\n\"Out of Sync Tracks\":0,\n\"Box Name\":\"2107.GXZ91\",\n\"Interval\":60}},\n{\"Query Time\":1587573174482,\n\"Session Number\":\"0x5f\",\n\"Hardware Time\":1587576146000,\n\"LSS\":\"0x90\",\n\"Out of Sync Tracks\":0,\n\"Box Name\":\"2107.GXZ91\",\n\"Interval\":60}],\n\"inserts\":[\"8kGM\"],\"timestamp\":1587587551801}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The session name." }, { "name" : "seqname", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the role pair to query" } ] } }, "\/sessions/{name}/getrpohistory/{seqname}" : { "put" : { "tags" : [ "SessionService" ], "description" : "

                                          getRPOHistory<\/h2>\nGet RPO History for a session in json format.\nTo determine possible dates call exportrpoconstraints and look at the dates for datatype OOS and convert the milliseconds returned into YYYY-MM-DD format\n\n

                                          Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: 8d72c750a81e429fa19cf6fd32d9f1ec' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/8kGM/getrpohistory/H1-J2 --data 'starttime=2020-04-22&endtime=2020-04-22'<\/code>", "operationId" : "getRPOHistory", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\n\"msg\":\"IWNR1284I\",\n\"resultText\":\"IWNR1284I [Apr 22, 2020 3:43:44 PM] The data for session 8kGM was retrieved.\",\n\"header\":[\"Query Time\",\"Hardware Time\",\"Interval\",\"Master Session Number\",\"Master Box Name\",\"Master LSS\",\"Master State\",\"Last Consistency Group Formation Time\",\"Average RPO\",\"RPO at Time of Last Query\",\"Successful Consistency Groups in Interval\",\"Number Failed Consistency Groups in Interval\",\"Number Failed Consistency Groups Since Last Successful\",\"Total LSSs\",\"Total Out of Sync Tracks\",\"Total Joined\",\"Total Suspended\",\"Most Recent Consistency Group Error\",\"Most Recent Consistency Group Error State\"],\n\"lines\":[\n{\"Query Time\":1587572988562,\n\"Master LSS\":\"0x90\",\n\"Average RPO\":0,\n\"Total Out of Sync Tracks\":0,\n\"Master Session Number\":\"0x5f\",\n\"Master State\":\"RUNNING\",\n\"Total Joined\":2,\n\"Number Failed Consistency Groups Since Last Successful\":0,\n\"Most Recent Consistency Group Error State\":\"NOT_APPLICABLE\",\n\"Master Box Name\":\"2107.GXZ91\",\n\"Last Consistency Group Formation Time\":1587575960000,\n\"Successful Consistency Groups in Interval\":0,\n\"Most Recent Consistency Group Error\":0,\n\"Total Suspended\":0,\n\"Hardware Time\":1587575960000,\n\"Number Failed Consistency Groups in Interval\":0,\n\"RPO at Time of Last Query\":0,\"Interval\":60,\"Total LSSs\":1},\n{\"Query Time\":1587573051951,\n\"Master LSS\":\"0x90\",\n\"Average RPO\":1500,\n\"Total Out of Sync Tracks\":0,\n\"Master Session Number\":\"0x5f\",\n\"Master State\":\"RUNNING\",\n\"Total Joined\":2,\n\"Number Failed Consistency Groups Since Last Successful\":0,\n\"Most Recent Consistency Group Error State\":\"NOT_APPLICABLE\",\n\"Master Box Name\":\"2107.GXZ91\",\n\"Last Consistency Group Formation Time\":1587576023000,\n\"Successful Consistency Groups in Interval\":63,\n\"Most Recent Consistency Group Error\":0,\n\"Total Suspended\":0,\n\"Hardware Time\":1587576023000,\n\"Number Failed Consistency Groups in Interval\":0,\n\"RPO at Time of Last Query\":0,\n\"Interval\":60,\"Total LSSs\":1}],\n\"inserts\":[\"8kGM\"],\n\"timestamp\":1587588224588}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The session name." }, { "name" : "seqname", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The role pair name." } ] } }, "\/sessions/{name}/group" : { "post" : { "tags" : [ "SessionService" ], "description" : "

                                          setSessionGroup<\/h2>\nChanges the user defined group name for a given session. A user defined group name can help in sorting and filtering sessions.\n\n

                                          Example curl:<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: c8f5a3eb11e74c4badaa066f0a493a99' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/sessions/8kGM/group --data group=testGroup<\/code>", "operationId" : "setSessionGroup", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1127I\",\"inserts\":[\"testGroup\"],\"results\":[{\"msg\":\"IWNR1128I\",\"inserts\":[\"8kGM\",\"testGroup\"],\"msgTranslated\":\"IWNR1128I [Apr 13, 2020 5:32:42 PM] The set session group command was able to assign session 8kGM to group testGroup successfully.\",\"timestamp\":1586817162298}],\"msgTranslated\":\"IWNR1127I [Apr 13, 2020 5:32:42 PM] The set session group command for group testGroup was successful.\",\"timestamp\":1586817162298}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session." } ] } }, "\/sessions/{name}/hyperswap_rolepair/{hyperswap_rolepair}" : { "post" : { "tags" : [ "SessionService" ], "description" : "

                                          externalHyperSwapManagement<\/h2>\nAllows an external management tool to externally set the state for HyperSwap on a session/role pair indicating that a swap could occur\nNOTE: This should only be called by an external product to coordinate with the session when HyperSwap capabilities are managed outside the session.\nThe session itself does nothing to validate the HyperSwap state\n\n

                                          Example curl:<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: c8f5a3eb11e74c4badaa066f0a493a99' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/sessions/MM/hyperswap_rolepair/H1-H2 --data hyperswap_state=TurnedOff<\/code>", "operationId" : "externalHyperSwapManagement", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1287I\",\"inserts\":[\"MM\",\"H1-H2\",\"TurnedOff\"],\"msgTranslated\":\"IWNR1287I [Apr 13, 2020 5:40:11 PM] The HyperSwap status for session MM and role pair H1-H2 was successfully set to TurnedOff.\",\"timestamp\":1586817611584}<\/code>" } }, "parameters" : [ { "name" : "hyperswap_rolepair", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Name of the role pair in the given session to set a HyperSwap state for" }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Name of the session to set the HyperSwap state" } ] } }, "\/sessions/{name}/hyperswap_rolepair/{hyperswap_rolepair}/event_name/{event_name}" : { "post" : { "tags" : [ "SessionService" ], "description" : "

                                          externalHyperSwapEventNotification<\/h2>\nAllows an external caller to indicate to the session that a HyperSwap event has occurred.\nThe event passed in will trigger the session to perform any actions necessary due to the event.\n\n

                                          Example curl:<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: c8f5a3eb11e74c4badaa066f0a493a99' -H 'Content-Type: application/x-www-form-urlencoded' -i 'https://hostname:9559/CSM/web/sessions/MM/hyperswap_rolepair/H1-H2/event_name/hyperswap%20event'<\/code>", "operationId" : "externalHyperSwapEventNotification", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1290I\",\"inserts\":[\"hyperswap event\",\"MM\",\"H1-H2\"],\"msgTranslated\":\"IWNR1290I [Apr 13, 2020 5:48:20 PM] The external HyperSwap event hyperswap event for session MM and role pair H1-H2 was successfully processed.\",\"timestamp\":1586818100543}<\/code>" } }, "parameters" : [ { "name" : "event_name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the event. Possible values:\n
                                            \n
                                          1. \"hyperswap event\"<\/li>\n
                                          2. \"hyperswap h1h2 event\"<\/li>\n
                                          3. \"hyperswap h1h3 event\"<\/li>\n
                                          4. \"hyperswap h2h3 event\"<\/li>\n
                                          5. \"hyperswap h3h4 event\"<\/li>\n<\/ol>" }, { "name" : "hyperswap_rolepair", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Name of the role pair in the session that had the event" }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Name of the session to issue the event to" } ] } }, "\/sessions/{name}/lastresults" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                            getLastCommandResults<\/h2>\nRetrieves the latest command results set on the pairs of the session specified.\n\n

                                            Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 8d72c750a81e429fa19cf6fd32d9f1ec' -H 'Content-Type: application/x-www-form-urlencoded' -i 'https://localhost:9559/CSM/web/sessions/8kGM/lastresults?types=[1,2,3]'<\/code>", "operationId" : "getLastCommandResults", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1575I\",\"resultText\":\"IWNR1575I [Apr 22, 2020 4:17:45 PM] The last command results for session 8kGM were successfully obtained.\",\"inserts\":[\"8kGM\"],\"timestamp\":1587590265847}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session" }, { "name" : "types", "in" : "query", "schema" : { "type" : "string" }, "description" : "An array of the types of messages to return. The type of messages, 1 for info, 2 for warning, 3 for errors." } ] } }, "\/sessions/{name}/options" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                            getOptions<\/h2>\nGets the options for the given session. The results returned from this method will vary depending on the session type.\n\n

                                            Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 8d72c750a81e429fa19cf6fd32d9f1ec' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/8kGM/options<\/code>", "operationId" : "getOptions", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command.\nSample result returning all the options for a DS8000 GM session\nNOTE: the \"type\" value for each option is what should be used for setOptions RESTApi. If type = unsupportedRestType then option can't be set through REST interface\n[{\"optionsname\":\"RPO_SEVERE_LEVEL_THRESHOLD\",\"min\":0,\"usercmdoptions\":null,\"max\":65535,\"thresholdLevel\":0,\"type\":\"rposeverelevelthreshold\",\"sequencename\":null},\n{\"optionsname\":\"RESET_SECONDARY_RESERVE\",\"min\":0,\"usercmdoptions\":null,\"max\":65535,\"isSet\":false,\"type\":\"resetsecondaryreserve\",\"sequencename\":null},\n{\"optionsname\":\"XDCCoordinationInterval\",\"min\":0,\"usercmdoptions\":null,\"max\":65535,\"chillin_timer\":50,\"type\":\"xdccoordinationintervaltime\",\"sequencename\":null},\n{\"optionsname\":\"Re-flash journal after recover\",\"min\":0,\"usercmdoptions\":null,\"max\":65535,\"isSet\":true,\"type\":\"flashtojournalafterrecovery\",\"sequencename\":null},\n{\"optionsname\":\"RPO_WARNING_LEVEL_THRESHOLD\",\"min\":0,\"usercmdoptions\":null,\"max\":65535,\"thresholdLevel\":0,\"type\":\"rpowarninglevelthreshold\",\"sequencename\":null},\n{\"optionsname\":\"MaxCGDrainTime\",\"croosin_timer\":240,\"min\":0,\"usercmdoptions\":null,\"max\":65535,\"type\":\"maxcgdraintime\",\"sequencename\":null},\n{\"optionsname\":\"RPO\",\"min\":35,\"usercmdoptions\":null,\"max\":150,\"type\":\"rpo\",\"sequencename\":null,\"desiredRPO\":45},\n{\"optionsname\":\"FAIL_IF_TGT_ONLINE\",\"min\":0,\"usercmdoptions\":null,\"max\":65535,\"isSet\":true,\"type\":\"mmfailiftgtonline\",\"sequencename\":null}]<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session." } ] }, "put" : { "tags" : [ "SessionService" ], "description" : "

                                            setOptions<\/h2>\nSets Options for a given session. Call getOptions to get a list of the valid options for a session. The \"type\" field returned by getOptions is the name of the option to use in this restcall.\n\nFor example when retrieving the RPO on a DS8000 GM session, getOptions will return\n{\"optionsname\":\"RPO\",\"min\":35,\"usercmdoptions\":null,\"max\":150,\"type\":\"rpo\",\"sequencename\":null,\"desiredRPO\":45}<\/code>\n\nTo set options build an array of options in the \"options\" FormParam where type matches what is returned in \"type\" from getOptions and then \"properties\" defines and array of values to set on that option.\n\nFor the RPO option above, to change the desiredRPO from 45 back to 0 we would define the \"options\" form parameter like the following:\noptions=[{\"type\":\"rpo\",\"properties\":[{\"desiredrpo\":0}]}]<\/code>\n\nNOTE: if getOptions returns the type as \"unsupportedRestType\" then calling this API for that option is not currently supported<\/b>\n\n\nThe following are examples for setting certain options on CSM sessions.\n<\/br>\nDS8000 related options<\/b>\n<\/br>\nSetting the Consistency Group Interval Time (RPO) on a GM session<\/b>\noptions=[{\"type\":\"rpo\",\"properties\":[{\"desiredrpo\":0}]}]<\/code>\n\nSetting the Maximum CG Drain Time on GM sessions<\/b>\noptions=[{\"type\":\"maxcgdraintime\",\"properties\":[{\"sequencename\":\"H1-J2\",\"crossintimer\":240}]}]<\/code>\n\nSetting the Maximum Coordination Interval on GM sessions<\/b>\noptions=[{\"type\":\"xdccoordinationintervaltime\",\"properties\":[{\"sequencename\":\"H1-J2\",\"chillintimer\":50}]}]<\/code>\n\nSetting the RPO Warning Level Threshold for a GM session<\/b>\noptions=[{\"type\":\"rpowarninglevelthreshold\",\"properties\":[{\"thresholdlevel\":60, \"sequencename\":\"H1-J2\"}]}]<\/code>\n\nSetting the RPO Severe Level Threshold for a GM session<\/b>\noptions=[{\"type\":\"rposeverelevelthreshold\",\"properties\":[{\"thresholdlevel\":60, \"sequencename\":\"H1-J2\"}]}]<\/code>\n\nSetting the option to disable the reflash to the journal after a recover on GM sessions<\/b>\noptions=[{\"type\":\"flashtojournalafterrecovery\",\"properties\":[{\"set\":false}]}]<\/code>\n\nSet the freeze Policy for MM sessions. Setting to false will consistently suspend the session but release I/O once suspended. Setting to true will prevent I/O to the primaries after the suspend. <\/b>\noptions=[{\"type\":\"freezepolicy\",\"properties\":[{\"set\":false}]}]<\/code>\n\nSet the option to Manage the H1H2 role pair with z/OS HyperSwap<\/b>\noptions=[{\"type\":\"hyperswap\",\"properties\":[{\"set\":true}]}]<\/code>\n\nSet z/OS HyperSwap management options for a loaded configuration<\/b>\noptions=[{\"type\":\"mmhyperswap\",\"properties\":[{\"hyperswapenabled\":true,\"configurationdataload\":false,\"plannedswap\":false,\"unplannedswap\":false,\"resetinusesecondaries\":false,\"unboxsecondaries\":false}]}]<\/code>\n\nSet z/OS sysplex association for a session<\/b>\noptions=[{\"type\":\"SYSPLEX\",\"properties\":[{\"associationName\":\"LOCAL\",}]}]<\/code>\n\nSet the option to fail a start of MM/GC pairs if the targets are online (CKD only)<\/b>\noptions=[{\"type\":\"mmfailiftgtonline\",\"properties\":[{\"set\":true}]}]<\/code>\n\nSet the option to reset any secondary reserves on pairs during the start<\/b>\noptions=[{\"type\":\"resetsecondaryreserve\",\"properties\":[{\"set\":true}]}]<\/code>\n\nSet the option to enable Hardened Freeze support on a session<\/b>\noptions=[{\"type\":\"zoshardenedfreeze\",\"properties\":[{\"set\":true}]}]<\/code>\n\nSet options on a FC session. Possible values for usersettableoptions are: NO_COPY, PERSISTENT, INCREMENTAL, ALLOW_PPRC_PRIMARY, PMIR_NO, PMIR_PREFERRED, PMIR_REQUIRED<\/b>\noptions=[{\"type\":\"essfc\",\"properties\":[{\"sequencename\":\"H1-T1\",\"usersettableoptions\":\"PERSISTENT,NO_COPY\"}]}]<\/code>\n\nSet the backup frequency allowed on a Safeguarded Copy session in mins<\/b>\noptions=[{\"type\":\"backupfrequency\",\"properties\":[{\"frequency\":30}]}]<\/code>\n\nSet the backup retention time for a Safeguarded Copy session in hrs<\/b>\noptions=[{\"type\":\"backupretention\",\"properties\":[{\"retention\":24}]}]<\/code>\n\nSet the recovery options for a Safeguarded Copy session. Possible values for usersettableoptions are: SGC_BACKGROUND_COPY and SGC_RECOVER_PERSISTENT<\/b>\noptions=[{\"type\":\"backuprecovery\",\"properties\":[{\"usersettableoptions\":\"SGC_BACKGROUND_COPY,SGC_RECOVER_PERSISTENT\"}]}]<\/code>\n\n\n\n<\/br>\nSpectrum Virtualize related options<\/b>\n<\/br>\nSetting the cycle period for Spectrum Virtualize sessions<\/b>\noptions=[{\"type\":\"cycleperiod\",\"properties\":[{\"cycleperiod\":6000}]}]<\/code>\n\nSetting the FC otions on Spectrum Virtualize FC sessions<\/b>\noptions=[{\"type\":\"svcfc\",\"properties\":[{\"sequencename\":\"H1-T1\",\"backgroundcopyrate\":0,\"incremental\":false}]}]<\/code>\n\nEnable Change Volumes on GMCV sessions<\/b>\noptions=[{\"type\":\"enablechangevolume\",\"properties\":[{\"set\":true}]}]<\/code>\n\nEnable Auto Restart on Spectrum Virtualize sessions for 1720/1920 suspensions<\/b>\noptions=[{\"type\":\"enableautorestart\",\"properties\":[{\"set\":true,\"delay\":120}]}]<\/code>\n\n\n\n\n\n

                                            Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: 8d72c750a81e429fa19cf6fd32d9f1ec' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/8kGM/options --data 'options=%5B%7B%22type%22%3A%22rpo%22%2C%22properties%22%3A%22%5B%7B'\\''min'\\''%3A35%2C'\\''max'\\''%3A150%2C'\\''desiredrpo'\\''%3A78%7D%5D%22%7D%5D'<\/code>", "operationId" : "setOptions", "responses" : { "204" : { "content" : { "*/*" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1228I\",\"inserts\":[\"8kGM\"],\"msgTranslated\":\"IWNR1228I [Apr 22, 2020 4:48:12 PM] The options for session 8kGM have been set successfully.\",\"timestamp\":1587592092225}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session." } ] } }, "\/sessions/{name}/pairs/{seqname}" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                            getPairInfo<\/h2>\nGets information for all the pairs in a given role pair.\n\n

                                            Example curl:<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: c8f5a3eb11e74c4badaa066f0a493a99' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/sessions/8kGM/pairs/H1-H2 <\/code>\n\n

                                            Principal JSON keys returned in response <\/h3>\n
                                              \n
                                            1. sourceid<\/b> - The ID for the source volume<\/li>\n
                                            2. sourcenickname<\/b> - The nickname for the source volume<\/li>\n
                                            3. targetid<\/b> - The ID for the target volume<\/li>\n
                                            4. targetnickname<\/b> - The nickname for the target volume<\/li>\n
                                            5. state<\/b> - The current state for the pair<\/li>\n
                                            6. seqname<\/b> - The role pair for the pair<\/li>\n
                                            7. isshadowing<\/b> - Whether the pair is currently copying data<\/li>\n
                                            8. isrecoverable<\/b> - Whether the pair is currently recoverable<\/li>\n
                                            9. lastresult<\/b> - The last result message for the pair<\/li>\n
                                            10. copyset<\/b> - The copyset ID that the pair is in<\/li>\n
                                            11. timestamp<\/b> - The timestamp that the pair is recoverable to if applicable<\/li>\n<\/ol>", "operationId" : "getPairInfo", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON string listing out all pairs and details for those pairs within the given role pair\nExample output:\n[{\"sourceid\":\"DS8000:2107.GXZ91:VOL:9001\",\n\"sourcenickname\":\"DS8000:2107.GXZ91:VOL:9001\",\n\"targetid\":\"DS8000:2107.GXZ91:VOL:9101\",\n\"targetnickname\":\"DS8000:2107.GXZ91:VOL:9101\",\n\"state\":\"Defined\",\n\"seqname\":\"H1-H2\",\n\"isshadowing\":false,\n\"isconsistent\":false,\n\"isrecoverable\":false,\n\"lastresult\":{\"msg\":\"IWNR2001I\",\"inserts\":[\"8kGM\",\"DS8000:2107.GXZ91:VOL:9001\",\"DS8000:2107.GXZ91:VOL:9001\",\"DS8000:2107.GXZ91:VOL:9101\",\"\",\"H1-H2\"],\"timestamp\":1586360144857},\n\"copyset\":\"DS8000:2107.GXZ91:VOL:9001\",\n\"timestamp\":\"n\\/a\"}] <\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session to query" }, { "name" : "seqname", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the role pair to query in the session" } ] } }, "\/sessions/{name}/recoveredbackups" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                              getRecoveredBackups<\/h2>\nGets all recovered backups for Spec V Safeguarded Copy session\n\n
                                                style=\"list-style-type:disc;\">\n
                                              1. name<\/b> the name of the session to query\n<\/ol>\n\n

                                                Example curl<\/h3>\ncurl -X GET -k -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/sessions/csmguigrp1/recoveredbackups/<\/code>", "operationId" : "getRecoveredBackups", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "This is the session name." } ] } }, "\/sessions/{name}/recoveredbackups/{backupid}" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                                getRecoveredBackupDetails<\/h2>\nGets the pair information for a specific recovered backup on a specific session\n
                                                  style=\"list-style-type:disc;\">\n
                                                1. name<\/b> the name of the session to query\n
                                                2. backupid<\/b> the backupid to get the detailed info for\n<\/ol>\n\n

                                                  Example curl<\/h3>\ncurl -X GET -k -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/sessions/csmguigrp1/recoveredbackups/1619029157<\/code>", "operationId" : "getRecoveredBackupDetails", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ { "name" : "backupid", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "This is the backupid in the session for safeguarded copies" }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "This is the session name." } ] } }, "\/sessions/{name}/requerystates" : { "put" : { "tags" : [ "SessionService" ], "description" : "

                                                  requeryStates<\/h2>\nThis method will query all of the copy sets in the specified session and update any states in the session that do not match the current state on the hardware.\nThis command can only be run periodically for each session.\n\n

                                                  Example curl:<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: e6bd5324sdf61b8fe4d513dsd8bd15f6' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/sessions/8kFC/requerystates<\/code>", "operationId" : "requeryStates", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\n{\"msg\":\"IWNR1306I\",\"inserts\":[\"8kFC\"],\"msgTranslated\":\"IWNR1306I [Apr 13, 2020 3:05:50 PM] The Refresh States command for session 8kFC was successful.\",\"timestamp\":1586808350432}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session" } ] } }, "\/sessions/{name}/sequences/{seqname}" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                                  getSequenceInfo<\/h2>\nGets a summary for a given role pair in a session. The results from this call provide information such as the following:\n\n\n
                                                    \n
                                                  1. seqname<\/b> the name of the sequence queried\n
                                                  2. isRecoverable<\/b> true if all the pairs in the role pair are currently recoverable\n
                                                  3. isShadowing<\/b> true if any pairs in the role pair are currently copying data\n
                                                  4. iosstate<\/b> ndicates the HyperSwap status for the pairs in the role pair\n
                                                  5. baseCopyType<\/b> the current base copy type for the pairs in the role pair ex. GC for Global Copy mode\n
                                                  6. direction<\/b> true if the direction of replication is going from the first role in the role pair to the second, false if going from the second to the first\n
                                                  7. statecounts<\/b> list of current pair states in the role pair and the number of pairs in each of the states\n
                                                  8. progress<\/b> indicates either the number of out of sync tracks and percentage copied, or the current data exposure\n<\/ol>\n\n\n

                                                    Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 8d72c750a81e429fa19cf6fd32d9f1ec' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/8kGM/sequences/H1-H2<\/code>", "operationId" : "getSequenceInfo", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\n{\"numpairs\":2,\n\"statecounts\":{\"Preparing\":\"2\"},\n\"numincg\":2,\n\"numwarning\":0,\n\"numshadowing\":2,\n\"numrecoverable\":0,\n\"isShadowing\":true,\n\"backupSupported\":false,\n\"iosstate\":\"TurnedOff\",\n\"exceptionNum\":0,\n\"notSeqToModify\":false,\n\"baseCopyType\":\"GC\",\n\"isRecoverable\":false,\n\"progress\":{\"totalTracksCount\":3276800,\"seqDirection\":true,\"totalCapacity\":{\"trackCount\":-1,\"size\":214748364800,\"type\":\"BYTES\"},\"copiedTracksCount\":3276800,\"percentComplete\":100,\"message\":{\"msg\":\"IWNR6013I\",\"resultText\":\"\",\"baseDate\":1587592997804,\"inserts\":[\"100\",\"H1\",\"H2\"],\"resultType\":0},\"remainingTracksCount\":0,\"sequenceName\":\"H1-H2\"},\n\"seqname\":\"H1-H2\",\n\"direction\":true,\n\"timestamp\":\"n\\/a\"}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session." }, { "name" : "seqname", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the role pair." } ] } }, "\/sessions/{name}/sequencespecs/{seqname}" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                                    getSequenceSpecifics<\/h2>\nGets specific info for a given sequence in a session. This includes information such as DS8000 Global Mirror statistics.\nResults from this method are different for each role pair and hardware type.\n\n

                                                    Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 22dd90e234a6454eaa85201797f6d5d3' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/8kGM/sequencespecs/H1-J2<\/code>", "operationId" : "getSequenceSpecifics", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample of DS8000 Global Mirror specifics on H1-J2 role pair\n{\"currenttime\":1587670786000,\n\"formationtimelastsuccessfulcg\":1587670761000,\n\"subordinateArrayString\":\"\",\n\"numberofunsuccessfulattempts\":0,\n\"masterSsid\":65424,\n\"numberofunsuccessfulcgs\":0,\n\"totalNumberOfUnsuccessfulConsistencyGroups\":0,\n\"fatalreasoncode\":0,\n\"cgintervaltime\":45,\n\"numberofSucessfulcgs\":2,\n\"currentRPO\":58500,\n\"masterLss\":144,\n\"masteressname\":\"2107.GXZ91\",\n\"sessionname\":\"8kGM\",\n\"maxCoordTime\":50,\n\"maxCGDrainTime\":240,\n\"successfulPercentage\":100,\n\"sequenceSpecificType\":1,\n\"asyncpprcstate\":1,\n\"sessionnumber\":95,\n\"totalNumberOfSuccessfulConsistencyGroups\":126,\n\"querytimeintervalsecs\":60,\n\"sequencename\":\"H1-J2\"}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "name of session" }, { "name" : "seqname", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "name of role pair to query" } ] } }, "\/sessions/{name}/sites/{sitename}" : { "post" : { "tags" : [ "SessionService" ], "description" : "

                                                    setLocationsForSite<\/h2>\nThis command allows the caller to set a user defined location name for a given site in a session\n\n

                                                    Example curl<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: 22dd90e234a6454eaa85201797f6d5d3' -H 'Content-Type: application/x-www-form-urlencoded' -i 'https://localhost:9559/CSM/web/sessions/8kGM/sites/Site%201' --data 'locations=[\"Tucson\",\"PHX\"]'<\/code>", "operationId" : "setLocationsForSite", "requestBody" : { "required" : false, "content" : { "application/x-www-form-urlencoded" : { "examples" : { "example" : { "value" : "locations=..." } }, "schema" : { "type" : "object", "title" : "null Data", "properties" : { "locations" : { "readOnly" : false, "description" : "A JSON formated array of Strings. Example: [\"Tucson\",\"PHX\"]", "type" : "string" } }, "description" : "

                                                    setLocationsForSite<\/h2>\nThis command allows the caller to set a user defined location name for a given site in a session\n\n

                                                    Example curl<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: 22dd90e234a6454eaa85201797f6d5d3' -H 'Content-Type: application/x-www-form-urlencoded' -i 'https://localhost:9559/CSM/web/sessions/8kGM/sites/Site%201' --data 'locations=[\"Tucson\",\"PHX\"]'<\/code>" } } } }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1096I\",\"inserts\":[\"8kGM\",\"Site 1\"],\"msgTranslated\":\"IWNR1096I [Apr 23, 2020 2:45:25 PM] The locations for sessions 8kGM and Site 1 were set successfully.\",\"timestamp\":1587671125071}<\/code>" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the sessiom" }, { "name" : "sitename", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" } ] } }, "\/sessions/{name}/snapgroups" : { "post" : { "tags" : [ "SessionService" ], "description" : "

                                                    runSnapGroupCommand<\/h2>\nRuns a snap group command on the specified snapgroups for the specified session.", "operationId" : "runSnapGroupCommand", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" } ] } }, "\/sessions/{name}/snapshots/{groupname}" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                                    getSnapshotInfo<\/h2>\nGets A9000/XIV Snaphots for the given session name and group name.", "operationId" : "getSnapshotInfo", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ { "name" : "groupname", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Results will return all snapshots in this groupname" }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "This is the session name." } ] } }, "\/sessions/{name}/snapshots/{role}/{snapshotid}" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                                    getSnapshotDetails<\/h2>\nGets detailed information for a given backup in a session. Use getSessionInfo to get the list of backups in a session.\n\nProvides the following details\n
                                                      \n
                                                    1. snapshotID<\/b> ID for the given snapshot queried<\/li>\n
                                                    2. snapshotName<\/b> Name for the given snapshot queried<\/li>\n
                                                    3. time<\/b> The time the snapshot was taken<\/li>\n
                                                    4. isValid<\/b> Whether the snapshot is recoverable<\/li>\n
                                                    5. numCopySets<\/b> The number of volumes that were in this snapshot<\/li>\n
                                                    6. backupVolumes<\/b> A JSON list of volumes that were in the snapshot<\/li>\n<\/ol>\n\n

                                                      Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 22dd90e234a6454eaa85201797f6d5d3' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/SGC/snapshots/H1/1587578175<\/code>", "operationId" : "getSnapshotDetails", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "name of session" }, { "name" : "role", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "name of role where the snapshot reside (ex. \"H1\")" }, { "name" : "snapshotid", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "" } ] } }, "\/sessions/{name}/snapshotsByName/{role}/{snapshotname}" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                                      getSnapshotDetailsByName<\/h2>\nGets detailed information for a given backup in a session. Use getSessionInfo to get the list of backups in a session.\n\nProvides the following details\n
                                                        \n
                                                      1. snapshotID<\/b> ID for the given snapshot queried<\/li>\n
                                                      2. snapshotName<\/b> Name for the given snapshot queried<\/li>\n
                                                      3. time<\/b> The time the snapshot was taken<\/li>\n
                                                      4. isValid<\/b> Whether the snapshot is recoverable<\/li>\n
                                                      5. numCopySets<\/b> The number of volumes that were in this snapshot<\/li>\n
                                                      6. backupVolumes<\/b> A JSON list of volumes that were in the snapshot<\/li>\n<\/ol>\n\n

                                                        Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 22dd90e234a6454eaa85201797f6d5d3' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/SGC/snapshots/H1/1587578175<\/code>", "operationId" : "getSnapshotDetailsByName", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "name of session" }, { "name" : "role", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "name of role where the snapshot reside (ex. \"H1\")" }, { "name" : "snapshotname", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" } ] } }, "\/sessions/{name}/storagedevices" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                                        Not currently supported for external use<\/h2>", "operationId" : "getSessionSystems", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" } ] } }, "\/sessions/{name}/storagedevices/roles" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                                        Not currently supported for external use<\/h2>", "operationId" : "getSessionSystemsAndRoles", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" } ] } }, "\/sessions/{name}/storagedevices/{devicename}" : { "get" : { "tags" : [ "SessionService" ], "description" : "

                                                        Not currently supported for external use<\/h2>", "operationId" : "getSessionSubSystems", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "devicename", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" } ] } }, "\/sessions/{name}/{force}/{soft}/copysets" : { "delete" : { "deprecated":true, "tags" : [ "SessionService" ], "description" : "

                                                        DEPRECATED. Use /zohost/{hostname}/{hostport}.<\/h2>\n\n

                                                        destroyCopyset<\/h2>\nRemoves Copy Sets from the given session.\n\n

                                                        Example curl<\/h3>\ncurl -X DELETE -k -H 'X-Auth-Token: 180b08e4d54649eb840305d73b6dacbb' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/MM/false/false/copysets --data 'copysets=[\"DS8000:2107.GXZ91:VOL:0001\"]&listenernumber=0'<\/code>", "operationId" : "destroyCopyset_old", "requestBody" : { "required" : false, "content" : { "application/x-www-form-urlencoded" : { "examples" : { "example" : { "value" : "copysets=...&listenernumber=..." } }, "schema" : { "type" : "object", "title" : "null Data", "properties" : { "copysets" : { "readOnly" : false, "description" : "List of copysetIDs to be removed.", "type" : "string" }, "listenernumber" : { "readOnly" : false, "description" : "Specify 0. Deleting copy sets is a long running process. This field is for future use in providing status of the progress for the add", "type" : "string" } }, "description" : "

                                                        DEPRECATED. Use /zohost/{hostname}/{hostport}.<\/h2>\n\n

                                                        destroyCopyset<\/h2>\nRemoves Copy Sets from the given session.\n\n

                                                        Example curl<\/h3>\ncurl -X DELETE -k -H 'X-Auth-Token: 180b08e4d54649eb840305d73b6dacbb' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/MM/false/false/copysets --data 'copysets=[\"DS8000:2107.GXZ91:VOL:0001\"]&listenernumber=0'<\/code>" } } } }, "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1058I\",\"inserts\":[\"MM\"],\"results\":[{\"msg\":\"IWNR2002I\",\"inserts\":[\"MM\",\"DS8000:2107.GXZ91:VOL:0001\",\"DS8000:2107.GXZ91:VOL:0001(CSM001)\",\"DS8000:2107.GXZ91:VOL:0101(CSM101)\",\"\",\"H1-H2\"],\"msgTranslated\":\"IWNR2002I [Apr 21, 2020 4:40:21 PM] The role pair H1-H2 was successfully deleted in session MM for copy set DS8000:2107.GXZ91:VOL:0001 with source DS8000:2107.GXZ91:VOL:0001(CSM001) and target DS8000:2107.GXZ91:VOL:0101(CSM101).\",\"timestamp\":1587505221407},{\"msg\":\"IWNR1095I\",\"inserts\":[\"DS8000:2107.GXZ91:VOL:0001\",\"MM\"],\"msgTranslated\":\"IWNR1095I [Apr 21, 2020 4:40:21 PM] Copy set DS8000:2107.GXZ91:VOL:0001 in session MM was successfully deleted.\",\"timestamp\":1587505221407}],\"msgTranslated\":\"IWNR1058I [Apr 21, 2020 4:40:21 PM] The copy sets for session MM were deleted.\",\"timestamp\":1587505221407}<\/code>" } }, "parameters" : [ { "name" : "force", "in" : "path", "required" : true, "schema" : { "type" : "boolean" }, "description" : "Force Set to true if you wish to remove the pair from CSM ignoring hardware errors." }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session." }, { "name" : "soft", "in" : "path", "required" : true, "schema" : { "type" : "boolean" }, "description" : "Keep base relationships on the hardware but remove the copy set from the session" } ] } }, "\/sessions/{name}/{force}/{soft}/copysets/{copysetids}" : { "delete" : { "tags" : [ "SessionService" ], "description" : "

                                                        destroyCopyset<\/h2>\nRemoves Copy Sets from the given session.\n\n

                                                        Example curl<\/h3>\ncurl -X DELETE -k -H 'X-Auth-Token: 180b08e4d54649eb840305d73b6dacbb' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/MM/false/false/copysets/https://localhost:9559/CSM/web/sessions/newsession/false/false/copysets/DS8000:2107.KMX61:VOL:0002,DS8000:2107.KMX61:VOL:0001<\/code>", "operationId" : "destroyCopyset", "requestBody" : { "required" : false, "content" : { "application/x-www-form-urlencoded" : { "examples" : { "example" : { "value" : "" } }, "schema" : { "type" : "object", "title" : "null Data", "description" : "

                                                        destroyCopyset<\/h2>\nRemoves Copy Sets from the given session.\n\n

                                                        Example curl<\/h3>\ncurl -X DELETE -k -H 'X-Auth-Token: 180b08e4d54649eb840305d73b6dacbb' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/sessions/MM/false/false/copysets/https://localhost:9559/CSM/web/sessions/newsession/false/false/copysets/DS8000:2107.KMX61:VOL:0002,DS8000:2107.KMX61:VOL:0001<\/code>" } } } }, "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1058I\",\"inserts\":[\"MM\"],\"results\":[{\"msg\":\"IWNR2002I\",\"inserts\":[\"MM\",\"DS8000:2107.GXZ91:VOL:0001\",\"DS8000:2107.GXZ91:VOL:0001(CSM001)\",\"DS8000:2107.GXZ91:VOL:0101(CSM101)\",\"\",\"H1-H2\"],\"msgTranslated\":\"IWNR2002I [Apr 21, 2020 4:40:21 PM] The role pair H1-H2 was successfully deleted in session MM for copy set DS8000:2107.GXZ91:VOL:0001 with source DS8000:2107.GXZ91:VOL:0001(CSM001) and target DS8000:2107.GXZ91:VOL:0101(CSM101).\",\"timestamp\":1587505221407},{\"msg\":\"IWNR1095I\",\"inserts\":[\"DS8000:2107.GXZ91:VOL:0001\",\"MM\"],\"msgTranslated\":\"IWNR1095I [Apr 21, 2020 4:40:21 PM] Copy set DS8000:2107.GXZ91:VOL:0001 in session MM was successfully deleted.\",\"timestamp\":1587505221407}],\"msgTranslated\":\"IWNR1058I [Apr 21, 2020 4:40:21 PM] The copy sets for session MM were deleted.\",\"timestamp\":1587505221407}<\/code>" } }, "parameters" : [ { "name" : "copysetids", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" }, { "name" : "force", "in" : "path", "required" : true, "schema" : { "type" : "boolean" }, "description" : "Force Set to true if you wish to remove the pair from CSM ignoring hardware errors." }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the session." }, { "name" : "soft", "in" : "path", "required" : true, "schema" : { "type" : "boolean" }, "description" : "Keep base relationships on the hardware but remove the copy set from the session" } ] } }, "\/storagedevices" : { "get" : { "deprecated":true, "tags" : [ "HardwareService" ], "description" : "

                                                        queryHardwareMappings<\/h2>\nDEPRECATED: Instead use /connectioninfo query to retrieve a list of devices and their connection states\nThis method will return all storage system connections currently defined on the server\n\n

                                                        Example curl<\/h3>\ncurl -X GET -k -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i 'https://localhost:9559/CSM/web/storagedevices?type=ds8000'<\/code>", "operationId" : "queryHardwareMappings", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command.\nExample output:\n[{\"serial\":\"GXZ91\",\n\"locationid\":-1,\n\"systemtype\":\"DS8000\",\n\"devicename\":\"GXZ91\",\n\"location\":null,\n\"deviceid\":\"DS8000:BOX:2107.GXZ91\",\n\"connections\":[{\"conntype\":\"DS8000 Hardware Management Console (HMC) Connection\",\"connectionid\":\"HMC:\\/boxAhostname.ibm.com\"}],\n\"machinemodelnumber\":\"2107\",\n\"manufacturer\":\"IBM\"},\n{\"serial\":\"KMX61\",\n\"locationid\":-1,\n\"systemtype\":\"DS8000\",\n\"devicename\":\"KMX61\",\n\"location\":null,\"deviceid\":\n\"DS8000:BOX:2107.KMX61\",\n\"connections\":[{\"conntype\":\"DS8000 Hardware Management Console (HMC) Connection\",\"connectionid\":\"HMC:\\/boxBhostname.ibm.com\"}],\n\"machinemodelnumber\":\"2107\",\n\"manufacturer\":\"IBM\"}]<\/code>" } }, "parameters" : [ { "name" : "type", "in" : "query", "schema" : { "type" : "string" }, "description" : "Type or storage system to be return. Possible values are:\n
                                                          \n
                                                        1. DS8000<\/b> Specify this for all DS8000 storage systems\n
                                                        2. DS<\/b> Specify this for all DS8000 storage systems\n
                                                        3. XIV<\/b> Specify this for XIV and A9000 storage systems\n
                                                        4. SVC<\/b> Specify this for all SVC/Storage Virtualize based storage systems\n
                                                        5. STORAGE-VIRTUALIZE<\/b> Specify this for all SVC/Storage Virtualize based storage systems\n
                                                        6. null<\/b> Do not specify a type to return all storage system connections\n<\/ol>" } ] }, "put" : { "tags" : [ "HardwareService" ], "description" : "

                                                          addHardwareMapping<\/h2>\nThis method will create a connection to a storage system\n\n

                                                          Example curl<\/h3>\ncurl -X PUT -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices --data 'deviceip=hostname&type=ds8000&deviceusername=admin&devicepassword=password'<\/code>", "operationId" : "addHardwareMapping", "requestBody" : { "required" : false, "content" : { "application/x-www-form-urlencoded" : { "examples" : { "example" : { "value" : "deviceip=...&devicepassword=...&deviceport=...&deviceusername=...&passticketapp=...&seconddeviceip=...&seconddevicepassword=...&seconddeviceport=...&seconddeviceusername=...&type=..." } }, "schema" : { "type" : "object", "title" : "null Data", "properties" : { "deviceip" : { "readOnly" : false, "description" : "IP address or hostname for the storage system", "type" : "string" }, "devicepassword" : { "readOnly" : false, "description" : "Password for the storage system connection", "type" : "string" }, "deviceport" : { "readOnly" : false, "description" : "Port to use for the connection to the storage system", "type" : "string" }, "deviceusername" : { "readOnly" : false, "description" : "User name for the storage system connection", "type" : "string" }, "passticketapp" : { "readOnly" : false, "description" : "", "type" : "string" }, "seconddeviceip" : { "readOnly" : false, "description" : "For DS8000 storage systems, the IP address or hostname of a secondary HMC system", "type" : "string" }, "seconddevicepassword" : { "readOnly" : false, "description" : "Password for the connection to the secondary HMC system for DS8000 connections", "type" : "string" }, "seconddeviceport" : { "readOnly" : false, "description" : "Port to use for the connection to the secondary HMC system for DS8000 connections", "type" : "string" }, "seconddeviceusername" : { "readOnly" : false, "description" : "User name for the connection to the secondary HMC system for DS8000 connections", "type" : "string" }, "type" : { "readOnly" : false, "description" : "Type or storage system being added. Possible values are:\n
                                                            \n
                                                          1. DS8000<\/b> Specify this for all DS8000 storage systems\n
                                                          2. XIV<\/b> Specify this for XIV storage systems\n
                                                          3. A9000<\/b> Specify this for A9000 storage systems\n
                                                          4. SVC<\/b> Specify this for all SVC/Storage Virtualize based storage systems\n
                                                          5. STORAGE-VIRTUALIZE<\/b> Specify this for all SVC/Storage Virtualize based storage systems\n<\/ol>", "type" : "string" } }, "description" : "

                                                            addHardwareMapping<\/h2>\nThis method will create a connection to a storage system\n\n

                                                            Example curl<\/h3>\ncurl -X PUT -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices --data 'deviceip=hostname&type=ds8000&deviceusername=admin&devicepassword=password'<\/code>" } } } }, "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNH1612I\",\"inserts\":[\"HMC:9.11.114.59\"],\"msgTranslated\":\"IWNH1612I [Apr 22, 2020 11:19:45 AM] The connection HMC:hostname was successfully added.\",\"timestamp\":1587572385863}<\/code>" } }, "parameters" : [ ] } }, "\/storagedevices/connectioninfo" : { "get" : { "tags" : [ "HardwareService" ], "description" : "

                                                            queryHardwareMappingsConnectionInfo<\/h2>\nThis method will return all storage system connections currently defined on the server and the local/remote state of the storage system\nNOTE: This should be used now instead of the base storagedevices query\n\n

                                                            Example curl<\/h3>\ncurl -X GET -k -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i 'https://localhost:9559/CSM/web/storagedevices/state?type=ds8000'<\/code>", "operationId" : "queryHardwareMappingsConnectionInfo", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command.\nExample output:\n[{\nconectiontype\": \"HMC\",\n\"remotestate\": null,\n\"locationid\": 1,\n\"ip\": \"HMC:9.11.114.57\",\n\"localstate\": \"CONNECTED\",\n\"devicename\": \"2107.GXZ91\",\n\"location\": \"Tucson\",\n\"deviceid\": \"DS8000:BOX:2107.GXZ91\",\n\"devicetype\": \"DS8000\",\n\"manufacturer\": \"IBM\"\n}, {\n\"conectiontype\": \"zOS Connection\",\n\"remotestate\": null,\n\"locationid\": 1,\n\"ip\": \"ZOS:ezu248.tuc.stglabs.ibm.com:5858\",\n\"localstate\": \"DISCONNECTED\",\n\"devicename\": \"2107.GXZ91\",\n\"location\": \"Tucson\",\n\"deviceid\": \"DS8000:BOX:2107.GXZ91\",\n\"devicetype\": \"DS8000\",\n\"manufacturer\": \"IBM\"\n}, {\n\"conectiontype\": \"Direct\",\n\"remotestate\": null,\n\"locationid\": -1,\n\"ip\": \"fab3-dev13.tms.stglabs.ibm.com\",\n\"localstate\": \"CONNECTED\",\n\"devicename\": \"fab3-dev13\",\n\"location\": null,\n\"deviceid\": \"STORAGE-VIRTUALIZE:CLUSTER:FAB3-DEV13\",\n\"devicetype\": \"IBM FlashSystem 7200\",\n\"manufacturer\": \"IBM\"\n}]<\/code>" } }, "parameters" : [ { "name" : "type", "in" : "query", "schema" : { "type" : "string" }, "description" : "Type or storage system to be return. Possible values are:\n
                                                              \n
                                                            1. DS8000<\/b> Specify this for all DS8000 storage systems\n
                                                            2. DS<\/b> Specify this for all DS8000 storage systems\n
                                                            3. XIV<\/b> Specify this for XIV and A9000 storage systems\n
                                                            4. SVC<\/b> Specify this for all SVC/Storage Virtualize based storage systems\n
                                                            5. STORAGE-VIRTUALIZE<\/b> Specify this for all SVC/Storage Virtualize based storage systems\n
                                                            6. null<\/b> Do not specify a type to return all storage system connections\n<\/ol>" } ] } }, "\/storagedevices/mapvolstohost" : { "put" : { "tags" : [ "HardwareService" ], "description" : "

                                                              unMapVolumesToHost<\/h2>\nThis method unmap a list of volumes from a host defined on a given Storage System\nNOTE: This method is for Spectrum Virtualize volume only\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices/mapvolstohost --data 'deviceId=FAB3-DEV13&hostname=\"fakehost1.ibm.com\"&volumes=[\"mVol0_211115100540\"]&force=true&isHostCluster=false'<\/code>", "operationId" : "mapVolumesToHost", "requestBody" : { "required" : false, "content" : { "application/x-www-form-urlencoded" : { "examples" : { "example" : { "value" : "deviceId=...&force=...&hostname=...&isHostCluster=...&scsi=...&volumes=..." } }, "schema" : { "type" : "object", "title" : "null Data", "properties" : { "deviceId" : { "readOnly" : false, "description" : "Name of the storage system the volume are on and hosts are attached to", "type" : "string" }, "force" : { "readOnly" : false, "description" : "true to force the mapping in case the volume is already mapped to a host", "type" : "string" }, "hostname" : { "readOnly" : false, "description" : "Name of the host or host cluster to map specified volumes to", "type" : "string" }, "isHostCluster" : { "readOnly" : false, "description" : "true if the hostname provided is a cluster otherwise false", "type" : "string" }, "scsi" : { "readOnly" : false, "description" : "(Optional) specify if you want to define a custom scsi id", "type" : "string" }, "volumes" : { "readOnly" : false, "description" : "json list of volumes to map to the specified host", "type" : "string" } }, "description" : "

                                                              unMapVolumesToHost<\/h2>\nThis method unmap a list of volumes from a host defined on a given Storage System\nNOTE: This method is for Spectrum Virtualize volume only\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices/mapvolstohost --data 'deviceId=FAB3-DEV13&hostname=\"fakehost1.ibm.com\"&volumes=[\"mVol0_211115100540\"]&force=true&isHostCluster=false'<\/code>" } } } }, "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR3125I\",\"inserts\":[\"1\"],\"msgTranslated\":\"IWNR3125I [Nov 15, 2021 11:02:44 AM] The create host mapping command completed successfully for 1 volumes.\",\"timestamp\":1636995764061}<\/code>" } }, "parameters" : [ ] } }, "\/storagedevices/paths" : { "get" : { "tags" : [ "HardwareService" ], "description" : "

                                                              queryAllGenericPaths<\/h2>\nQuery for all the logical paths on the storage system\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices/paths<\/code>", "operationId" : "queryAllGenericPaths", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command.\nExample output:\n[{\"elementid\": \"ESS:PATH:2107.GXZ91:D2:2107.KMX61:D0\",\n\"pathsourceid\": \"2107.GXZ91:D2\",\n\"numberofgoodpaths\": 1,\n\"numberofpaths\": 1,\n\"elementkey\": \"ESS:PATH:2107.GXZ91:D2:2107.KMX61:D0\",\n\"state\": 1,\n\"pathtargetid\": \"2107.KMX61:D0\",\n\"pathtype\": 1,\n\"numberoferrorpaths\": 0,\n\"storagetype\": \"ESS\",\n\"detailedstate\": 19\n},{\"elementid\": \"ESS:PATH:2107.GXZ91:D0:2107.KMX61:D0\",\n\"pathsourceid\": \"2107.GXZ91:D0\",\n\"numberofgoodpaths\": 1,\n\"numberofpaths\": 1,\n\"elementkey\": \"ESS:PATH:2107.GXZ91:D0:2107.KMX61:D0\",\n\"state\": 1,\n\"pathtargetid\": \"2107.KMX61:D0\",\n\"pathtype\": 1,\n\"numberoferrorpaths\": 0,\n\"storagetype\": \"ESS\",\n\"detailedstate\": 19\n}]<\/code>" } }, "parameters" : [ ] } }, "\/storagedevices/paths/{id}" : { "get" : { "tags" : [ "HardwareService" ], "description" : "

                                                              queryAllPaths<\/h2>\nQuery for all paths on the given storage system\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i 'https://localhost:9559/CSM/web/storagedevices/paths/DS8000:BOX:2107.GXZ91'<\/code>", "operationId" : "queryAllPaths", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command.\nExample output:\n[{ \"elementid\": \"ESS:PATH:2107.GXZ91:FFD2:D2:2107.KMX61:FFD0:D0\",\n\"numberofgoodpaths\": 1,\n\"pathportstates\": \"19\",\n\"pathsourceports\": \"16\",\n\"sourcewwwn\": \"5766023019835152291\",\n\"pathstring\": \"ESS:PATH:2107.GXZ91:FFD2:D2:2107.KMX61:FFD0:D0:PathType=1:State=1:NumPaths=1:NumErrorPaths=0:srcSSID=0xffd2:tgtSSID=0xffd0:srcWWNN=5766023019835152291:tgtWWNN=5766023019868705591::PathPorts[0]=16->768(state=19|false)\",\n\"pathtargetports\": \"768\",\n\"targetssid\": 65488,\n\"storagetype\": \"ESS\",\n\"sourcemachinetype\": 1,\n\"targetboxname\": \"2107.KMX61\",\n\"numberofpaths\": 1,\n\"targetplantofmanufacturer\": \"75\",\n\"sourcelss\": 210,\n\"elementkey\": \"ESS:PATH:2107.GXZ91:FFD2:D2:2107.KMX61:FFD0:D0\",\n\"sourcessid\": 65490,\n\"targetlss\": 208,\n\"targetwwwn\": \"5766023019868705591\",\n\"sourceplantofmanufacturer\": \"00075\",\n\"state\": 1,\n\"pathtype\": 1,\n\"targetmachinetype\": 1,\n\"numberoferrorpaths\": 0,\n\"sourceboxname\": \"2107.GXZ91\"\n}, {\"elementid\": \"ESS:PATH:2107.GXZ91:FFD0:D0:2107.KMX61:FFD0:D0\",\n\"numberofgoodpaths\": 1,\n\"pathportstates\": \"19\",\n\"pathsourceports\": \"304\",\n\"sourcewwwn\": \"5766023019835152291\",\n\"pathstring\": \"ESS:PATH:2107.GXZ91:FFD0:D0:2107.KMX61:FFD0:D0:PathType=1:State=1:NumPaths=1:NumErrorPaths=0:srcSSID=0xffd0:tgtSSID=0xffd0:srcWWNN=5766023019835152291:tgtWWNN=5766023019868705591::PathPorts[0]=304->561(state=19|false)\",\n\"pathtargetports\": \"561\",\n\"targetssid\": 65488,\n\"storagetype\": \"ESS\",\n\"sourcemachinetype\": 1,\n\"targetboxname\": \"2107.KMX61\",\n\"numberofpaths\": 1,\n\"targetplantofmanufacturer\": \"75\",\n\"sourcelss\": 208,\n\"elementkey\": \"ESS:PATH:2107.GXZ91:FFD0:D0:2107.KMX61:FFD0:D0\",\n\"sourcessid\": 65488,\n\"targetlss\": 208,\n\"targetwwwn\": \"5766023019868705591\",\n\"sourceplantofmanufacturer\": \"00075\",\n\"state\": 1,\n\"pathtype\": 1,\n\"targetmachinetype\": 1,\n\"numberoferrorpaths\": 0,\n\"sourceboxname\": \"2107.GXZ91\"\n}]<\/code>" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" } ] } }, "\/storagedevices/refreshvolumegroups/{synchronous}" : { "put" : { "tags" : [ "HardwareService" ], "description" : "

                                                              refreshVolumeGroupConfig<\/h2>\nRefreshes the Volume Group configurations for all Storage Virtualize systems connected to the server\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i 'https://localhost:9559/CSM/web/storagedevices/refreshvolumegroups/true<\/code>", "operationId" : "refreshVolumeGroups", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\": \"IWNH1611I\",\n\"inserts\": [\"DS8000:BOX:2107.GXZ91\"],\n\"msgTranslated\": \"IWNH1611I [Apr 21, 2020 1:08:43 PM] A refresh of the storage configuration has completed for the storage device DS8000:BOX:2107.GXZ91.\",\n\"timestamp\": 1587492523136}<\/code>" } }, "parameters" : [ { "name" : "synchronous", "in" : "path", "required" : true, "schema" : { "type" : "boolean" }, "description" : "" } ] } }, "\/storagedevices/svchost/{deviceName}" : { "get" : { "tags" : [ "HardwareService" ], "description" : "

                                                              querySVChosts<\/h2>\nThis method returns a list of hosts defined to the Spec V system\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices/svchost/FAB3-DEV13<\/code>", "operationId" : "querySVChosts", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command.\nExample output:\n{\n\"hosts\": [{\n\"protocol\": \"scsi\",\n\"name\": \"omnigui.tms.stglabs.ibm.com\",\n\"id\": 0,\n\"status\": \"online\"\n}, {\n\"protocol\": \"nvme\",\n\"hostcount\": 1,\n\"name\": \"anotherfakehostcluster\",\n\"id\": 1,\n\"status\": \"offline\"\n}]\n}}<\/code>" } }, "parameters" : [ { "name" : "deviceName", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Name of the storage system the volume are on and hosts are attached. Use the device name and not the ID." } ] } }, "\/storagedevices/unmapvolstohost" : { "put" : { "tags" : [ "HardwareService" ], "description" : "

                                                              unMapVolumesToHost<\/h2>\nThis method unmap a list of volumes from a host defined on a given Storage System\nNOTE: This method is for Spectrum Virtualize volume only\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic SEFE23DDFerdsfs=' -i https://localhost:9559/CSM/web/storagedevices/unmapvolstohost --data 'deviceId=FAB3-DEV13&hostname=\"fakehost1.ibm.com\"&volumes=[\"mVol0_211115100540\"]&isHostCluster=false'<\/code>", "operationId" : "unMapVolumesToHost", "requestBody" : { "required" : false, "content" : { "application/x-www-form-urlencoded" : { "examples" : { "example" : { "value" : "deviceId=...&hostname=...&isHostCluster=...&volumes=..." } }, "schema" : { "type" : "object", "title" : "null Data", "properties" : { "deviceId" : { "readOnly" : false, "description" : "Name of the storage system the volume are on and hosts are attached to", "type" : "string" }, "hostname" : { "readOnly" : false, "description" : "Name of the host or host cluster to map specified volumes to", "type" : "string" }, "isHostCluster" : { "readOnly" : false, "description" : "true if the hostname provided is a cluster otherwise false", "type" : "string" }, "volumes" : { "readOnly" : false, "description" : "json list of volumes to map to the specified host", "type" : "string" } }, "description" : "

                                                              unMapVolumesToHost<\/h2>\nThis method unmap a list of volumes from a host defined on a given Storage System\nNOTE: This method is for Spectrum Virtualize volume only\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic SEFE23DDFerdsfs=' -i https://localhost:9559/CSM/web/storagedevices/unmapvolstohost --data 'deviceId=FAB3-DEV13&hostname=\"fakehost1.ibm.com\"&volumes=[\"mVol0_211115100540\"]&isHostCluster=false'<\/code>" } } } }, "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR3126I\",\"inserts\":[\"1\"],\"msgTranslated\":\"IWNR3126I [Nov 15, 2021 10:57:46 AM] The remove host mapping completed successfuly for 1 volumes.\",\"timestamp\":1636995466599}<\/code>" } }, "parameters" : [ ] } }, "\/storagedevices/updatehmc" : { "put" : { "tags" : [ "HardwareService" ], "description" : "

                                                              updateHMCConnection<\/h2>\nThis method will update the user name and/or password of an HMC connection.\nNOTE: This method will not allow you to change the IP of an existing HMC connection. Create a new connection to change the IP.\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46cGFzc3cwcmQ=' -i https://localhost:9559/CSM/web/storagedevices/updatehmc --data 'deviceip=myHMC.ibm.com&devicepassword=passw0rd&deviceusername=admin&name=HMC:myHMC.ibm.com'<\/code>", "operationId" : "updateHMCConnection", "requestBody" : { "required" : false, "content" : { "application/x-www-form-urlencoded" : { "examples" : { "example" : { "value" : "deviceip=...&devicepassword=...&deviceusername=...&name=...&passticketapp=..." } }, "schema" : { "type" : "object", "title" : "null Data", "properties" : { "deviceip" : { "readOnly" : false, "description" : "Primary IP address for the storage system (only specify primary even if connection uses dual HMC)", "type" : "string" }, "devicepassword" : { "readOnly" : false, "description" : "New password for the storage system connection", "type" : "string" }, "deviceusername" : { "readOnly" : false, "description" : "New user name for the storage system connection", "type" : "string" }, "name" : { "readOnly" : false, "description" : "Name of the connection HMC:9.11.114.59", "type" : "string" }, "passticketapp" : { "readOnly" : false, "description" : "", "type" : "string" } }, "description" : "

                                                              updateHMCConnection<\/h2>\nThis method will update the user name and/or password of an HMC connection.\nNOTE: This method will not allow you to change the IP of an existing HMC connection. Create a new connection to change the IP.\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46cGFzc3cwcmQ=' -i https://localhost:9559/CSM/web/storagedevices/updatehmc --data 'deviceip=myHMC.ibm.com&devicepassword=passw0rd&deviceusername=admin&name=HMC:myHMC.ibm.com'<\/code>" } } } }, "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNH1612I\",\"inserts\":[\"HMC:9.11.114.59\"],\"msgTranslated\":\"IWNH1612I [Apr 22, 2020 11:19:45 AM] The connection HMC:hostname was successfully added.\",\"timestamp\":1587572385863}<\/code>" } }, "parameters" : [ ] } }, "\/storagedevices/updatespecv" : { "put" : { "tags" : [ "HardwareService" ], "description" : "

                                                              updateSpecVConnection<\/h2>\nThis method will update the user name and/or password of a Spec V Connection\nNOTE: This method will not allow you to change the IP of an existing Spec V connection. Create a new connection to change the IP.\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46cGFzc3cwcmQ=' -i https://localhost:9559/CSM/web/storagedevices/updatespecv --data 'deviceip=myspecV.ibm.com&devicepassword=passw0rd&deviceusername=admin'<\/code>", "operationId" : "updateSpecVConnection", "requestBody" : { "required" : false, "content" : { "application/x-www-form-urlencoded" : { "examples" : { "example" : { "value" : "deviceip=...&devicepassword=...&deviceusername=..." } }, "schema" : { "type" : "object", "title" : "null Data", "properties" : { "deviceip" : { "readOnly" : false, "description" : "IP address for the storage system", "type" : "string" }, "devicepassword" : { "readOnly" : false, "description" : "New password for the storage system connection", "type" : "string" }, "deviceusername" : { "readOnly" : false, "description" : "New or existing user name for the storage system connection", "type" : "string" } }, "description" : "

                                                              updateSpecVConnection<\/h2>\nThis method will update the user name and/or password of a Spec V Connection\nNOTE: This method will not allow you to change the IP of an existing Spec V connection. Create a new connection to change the IP.\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46cGFzc3cwcmQ=' -i https://localhost:9559/CSM/web/storagedevices/updatespecv --data 'deviceip=myspecV.ibm.com&devicepassword=passw0rd&deviceusername=admin'<\/code>" } } } }, "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ ] } }, "\/storagedevices/volumes/volwwn" : { "post" : { "tags" : [ "HardwareService" ], "description" : "

                                                              queryMultipleVolumesByLUNSerial<\/h2>\nThis method will return all volumes for a given storage system for all passed in volumes\nNote: The query will find all volumes in the list of names\nex. Entering a specific volume wwn will return a single volume but entering something like 75GXZ91FB will return all volumes on box GXZ91 LSS FB.\n\n

                                                              Example curl<\/h3>\ncurl -X POST -k -H 'Accept-Language: en-US' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices/volumes/volwwn --data 'names=[\"6005076307FFD7A3000000000000F807\",\"6005076307FFD7A3000000000000F808\"]'<\/code>\n\n\n[{\"elementid\":\"SVC:VOL:SVC-SVC4:1\",\"isprotected\":false,\"grainsize\":256,\"capacitytype\":\"Bytes\",\"protectedby\":\"nobody\",\"lockedtype\":\"NA\",\"parentid\":\"SVC:IOGROUP:SVC-SVC4:1\",\"volume_wwn\":\"600507680C8104B5400000000000000D\",\"capacity\":107374182400,\"elementtype\":\"FIXEDBLK\",\"internalname\":\"SVC:VOL:0000020320412D50:1\",\"manufacturer\":\"IBM\",\"iszattached\":false,\"specifictype\":\"SVC\",\"isalive\":true,\"spaceefficenttype\":\"SE\",\"nickname\":\"ESX_ama-coh4_copy\",\"basetype\":\"VOL\",\"modified\":\"NA\",\"superparentid\":\"SVC:CLUSTER:SVC-SVC4\",\"isspaceefficient\":true}]\n<\/code>", "operationId" : "queryMultipleVolumesByLUNSerial", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing all volumes that match the input names" } }, "parameters" : [ ] } }, "\/storagedevices/volumes/volwwn/{name}" : { "get" : { "tags" : [ "HardwareService" ], "description" : "

                                                              queryVolumesByLUNSerial<\/h2>\nThis method will return all volumes for a given storage system based off the input volume wwn\nNote: The query will find all volumes that contain the input volume wwn\nex. Entering a specific volume wwn will return a single volume but entering something like 75GXZ91FB will return all volumes on box GXZ91 LSS FB.\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'Accept-Language: fr,en-US' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices/volumes/volwwn/600507680C8104B54000000000000000<\/code>\n\n\n[{\"elementid\":\"SVC:VOL:SVC-SVC4:1\",\"isprotected\":false,\"grainsize\":256,\"capacitytype\":\"Bytes\",\"protectedby\":\"nobody\",\"lockedtype\":\"NA\",\"parentid\":\"SVC:IOGROUP:SVC-SVC4:1\",\"volume_wwn\":\"600507680C8104B5400000000000000D\",\"capacity\":107374182400,\"elementtype\":\"FIXEDBLK\",\"internalname\":\"SVC:VOL:0000020320412D50:1\",\"manufacturer\":\"IBM\",\"iszattached\":false,\"specifictype\":\"SVC\",\"isalive\":true,\"spaceefficenttype\":\"SE\",\"nickname\":\"ESX_ama-coh4_copy\",\"basetype\":\"VOL\",\"modified\":\"NA\",\"superparentid\":\"SVC:CLUSTER:SVC-SVC4\",\"isspaceefficient\":true}]\n<\/code>", "operationId" : "queryVolumesByLUNSerial", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the volume with the specific lun serial or all of the volumes that match the input volume wwn" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The volume wwn you would like to find, or a subset of the volume wwn to retrieve a list of volumes" } ] } }, "\/storagedevices/volumes/{name}" : { "get" : { "tags" : [ "HardwareService" ], "description" : "

                                                              queryVolumesByStorageSystem<\/h2>\nThis method will return all volumes for a given storage system based off the input devicename from the get storage devices query\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'Accept-Language: fr,en-US' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices/volumes/SVC4<\/code>\n\n\n[{\"elementid\": \"SVC:VOL:SVC-SVC4:0\",\n\"isprotected\": false,\n\"grainsize\": 256,\n\"capacitytype\": \"Bytes\",\n\"protectedby\": \"nobody\",\n\"lockedtype\": \"NA\",\n\"parentid\": \"SVC:IOGROUP:SVC-SVC4:0\",\n\"lunserial\": \"600507680C8104B5400000000000000C\",\n\"capacity\": 107374182400,\n\"elementtype\": \"FIXEDBLK\",\n\"internalname\": \"SVC:VOL:0000020320412D50:0\",\n\"manufacturer\": \"IBM\",\n\"iszattached\": false,\n\"specifictype\": \"SVC\",\n\"isalive\": true,\n\"spaceefficenttype\": \"SE\",\n\"nickname\": \"ESX_ama-coh3_copy\",\n\"basetype\": \"VOL\",\n\"modified\": \"NA\",\n\"superparentid\": \"SVC:CLUSTER:SVC-SVC4\",\n\"isspaceefficient\": true\n},\n{\"elementid\": \"SVC:VOL:SVC-SVC4:1\",\n\"isprotected\": false,\n\"grainsize\": 256,\n\"capacitytype\": \"Bytes\",\n\"protectedby\": \"nobody\",\n\"lockedtype\": \"NA\",\n\"parentid\": \"SVC:IOGROUP:SVC-SVC4:1\",\n\"lunserial\": \"600507680C8104B5400000000000000D\",\n\"capacity\": 107374182400,\n\"elementtype\": \"FIXEDBLK\",\n\"internalname\": \"SVC:VOL:0000020320412D50:1\",\n\"manufacturer\": \"IBM\",\n\"iszattached\": false,\n\"specifictype\": \"SVC\",\n\"isalive\": true,\n\"spaceefficenttype\": \"SE\",\n\"nickname\": \"ESX_ama-coh4_copy\",\n\"basetype\": \"VOL\",\n\"modified\": \"NA\",\n\"superparentid\": \"SVC:CLUSTER:SVC-SVC4\",\n\"isspaceefficient\": true}]\n<\/code>", "operationId" : "queryVolumesByStorageSystem", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing all the volumes for that storage system" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Device name of the storage system as defined by the get storage devices query Example: SVC4" } ] } }, "\/storagedevices/zoscandidate" : { "get" : { "tags" : [ "HardwareService" ], "description" : "

                                                              zoscandidatedevices<\/h2>\nThis method will query for the devices in REST that are attached to the zos system.\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Accept-Language: en-US' -H 'Authorization: Basic Y3utY5RtiW46Y9Nt' -i https://localhost:9559/CSM/web/storagedevices/zoscandidate<\/code>", "operationId" : "zoscandidatedevices", "requestBody" : { "required" : false, "content" : { "application/x-www-form-urlencoded" : { "examples" : { "example" : { "value" : "" } }, "schema" : { "type" : "object", "title" : "null Data", "description" : "

                                                              zoscandidatedevices<\/h2>\nThis method will query for the devices in REST that are attached to the zos system.\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Accept-Language: en-US' -H 'Authorization: Basic Y3utY5RtiW46Y9Nt' -i https://localhost:9559/CSM/web/storagedevices/zoscandidate<\/code>" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{{\"serverMappings\":[{\"vendor\":\"IBM\",\"deviceDeviceName\":\"2389.GJK93\",\"type\":\"DS8000\",\"deviceElementID\":\"DS8000:CAL:2389.GJK93\",\"serverConfigName\":\"ZOS:2389.GJK93\"},{\"vendor\":\"IBM\",\"deviceDeviceName\":\"5382.OAE67\",\"type\":\"DS8000\",\"deviceElementID\":\"DS8000:CAL:5382.OAE67\",\"serverConfigName\":\"ZOS:5382.OAE67\"}}<\/code>" } }, "parameters" : [ ] } }, "\/storagedevices/zoscert" : { "post" : { "tags" : [ "HardwareService" ], "description" : "

                                                              addCert<\/h2>\nThis method will add a given cert to zos connection\n\n

                                                              Example curl<\/h3>\ncurl -X POST -k -H 'Accept-Language: en-US' -H 'Content-Type: multipart/form-data' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices/zoscert --form 'file=@\"ziJziJeMk/csm.cert234<\/code>", "operationId" : "addCert", "requestBody" : { "required" : false, "content" : { "multipart/form-data" : { "examples" : { "example" : { "value" : "" } }, "schema" : { "type" : "object", "title" : "null Data", "description" : "

                                                              addCert<\/h2>\nThis method will add a given cert to zos connection\n\n

                                                              Example curl<\/h3>\ncurl -X POST -k -H 'Accept-Language: en-US' -H 'Content-Type: multipart/form-data' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices/zoscert --form 'file=@\"ziJziJeMk/csm.cert234<\/code>" } } } }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR4207I\",\"inserts\":[],\"msgTranslated\":\"IWNR4207I [Jul 13, 2023, 4:08:30 PM] Successfully updated z\\/OS host certificates.\",\"timestamp\":1689282510484}<\/code>" } }, "parameters" : [ ] } }, "\/storagedevices/zosdevice" : { "put" : { "tags" : [ "HardwareService" ], "description" : "

                                                              addstorsys<\/h2>\nThis method will add a storage system through the zoshost connection.\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Accept-Language: en-US' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices/zosdevice --data 'deviceid=DS8000:CAL:2345.DGR32'<\/code>", "operationId" : "addstorsys", "requestBody" : { "required" : false, "content" : { "application/x-www-form-urlencoded" : { "examples" : { "example" : { "value" : "deviceid=..." } }, "schema" : { "type" : "object", "title" : "null Data", "properties" : { "deviceid" : { "readOnly" : false, "description" : "Storage system name", "type" : "string" } }, "description" : "

                                                              addstorsys<\/h2>\nThis method will add a storage system through the zoshost connection.\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Accept-Language: en-US' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices/zosdevice --data 'deviceid=DS8000:CAL:2345.DGR32'<\/code>" } } } }, "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{{\"msg\":\"IWNH1619I\",\"inserts\":[\"DS8000:CAL:2345.DGR32\"],\"msgTranslated\":\"IWNH1619I [May 8, 2023, 11:43:10 AM] The storage device DS8000:CAL:2345.DGR32 at ZOS was successfully added.\",\"timestamp\":1683564190084}}<\/code>" } }, "parameters" : [ ] } }, "\/storagedevices/zoshost" : { "delete" : { "deprecated":true, "tags" : [ "HardwareService" ], "description" : "

                                                              DEPRECATED. Use /zohost/{hostname}/{hostport}.<\/h2>\n\n

                                                              removeZOShost<\/h2>\nThis method will remove a zos connection with the given IP and port\n\n

                                                              Example curl<\/h3>\ncurl -X DELETE -k -H 'Accept-Language: en-US' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices/zoshost --data 'hostip=fakehost.ibm.com&hostport=5696'<\/code>", "operationId" : "removeZOShost_old", "requestBody" : { "required" : false, "content" : { "application/x-www-form-urlencoded" : { "examples" : { "example" : { "value" : "hostip=...&hostport=..." } }, "schema" : { "type" : "object", "title" : "null Data", "properties" : { "hostip" : { "readOnly" : false, "description" : "Primary IP address for the zos system", "type" : "string" }, "hostport" : { "readOnly" : false, "description" : "Port for the zos system", "type" : "string" } }, "description" : "

                                                              DEPRECATED. Use /zohost/{hostname}/{hostport}.<\/h2>\n\n

                                                              removeZOShost<\/h2>\nThis method will remove a zos connection with the given IP and port\n\n

                                                              Example curl<\/h3>\ncurl -X DELETE -k -H 'Accept-Language: en-US' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices/zoshost --data 'hostip=fakehost.ibm.com&hostport=5696'<\/code>" } } } }, "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{{\"msg\":\"IWNR7002I\",\"inserts\":[\"[fakehost.com]:7485\"],\"msgTranslated\":\"IWNR7002I [Mar 1, 2023, 4:31:18 PM] Connection [fakehost.ibm.com]:7485 removed successfully.\",\"timestamp\":1677709878826}}<\/code>" } }, "parameters" : [ ] }, "get" : { "tags" : [ "HardwareService" ], "description" : "

                                                              getZOShosts<\/h2>\nThis method will get the zoshost connections info\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'Accept-Language: en-US' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices/zoshost <\/code>", "operationId" : "getZOShosts", "requestBody" : { "required" : false, "content" : { "application/x-www-form-urlencoded" : { "examples" : { "example" : { "value" : "" } }, "schema" : { "type" : "object", "title" : "null Data", "description" : "

                                                              getZOShosts<\/h2>\nThis method will get the zoshost connections info\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'Accept-Language: en-US' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices/zoshost <\/code>" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{{\"msg\":\"IWNR7002I\",\"inserts\":[\"[fakehost.com]:7485\"],\"msgTranslated\":\"IWNR7002I [Mar 1, 2023, 4:31:18 PM] Connection [fakehost.ibm.com]:7485 removed successfully.\",\"timestamp\":1677709878826}}<\/code>" } }, "parameters" : [ ] }, "put" : { "tags" : [ "HardwareService" ], "description" : "

                                                              addZOShost<\/h2>\nThis method will create a zos connection to the current IP\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'Accept-Language: en-US' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices/zoshost --data 'hostip=fakehost.ibm.com&password=passw0rd&username=username&hostport=5696'<\/code>", "operationId" : "addZOShost", "requestBody" : { "required" : false, "content" : { "application/x-www-form-urlencoded" : { "examples" : { "example" : { "value" : "hostip=...&hostport=...&password=...&username=..." } }, "schema" : { "type" : "object", "title" : "null Data", "properties" : { "hostip" : { "readOnly" : false, "description" : "Primary IP address for the zos system", "type" : "string" }, "hostport" : { "readOnly" : false, "description" : "Port for the zos system", "type" : "string" }, "password" : { "readOnly" : false, "description" : "New password or PassTicket key for the zos system connection", "type" : "string" }, "username" : { "readOnly" : false, "description" : "New user name for the zos system connection", "type" : "string" } }, "description" : "

                                                              addZOShost<\/h2>\nThis method will create a zos connection to the current IP\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'Accept-Language: en-US' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices/zoshost --data 'hostip=fakehost.ibm.com&password=passw0rd&username=username&hostport=5696'<\/code>" } } } }, "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{{\"msg\":\"IWNR7000I\",\"inserts\":[\"[fakehost.ibm.com]:5858\"],\"msgTranslated\":\"IWNR7000I [Feb 16, 2023, 3:19:57 PM] Connection [fakehost.ibm.com]:5696 added successfully.\",\"timestamp\":1676582397050}}<\/code>" } }, "parameters" : [ ] } }, "\/storagedevices/zoshost/{hostname}/{hostport}" : { "delete" : { "tags" : [ "HardwareService" ], "description" : "

                                                              removeZOShost<\/h2>\nThis method will remove a zos connection with the given IP and port\n\n

                                                              Example curl<\/h3>\ncurl -X DELETE -k -H 'Accept-Language: en-US' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices/zoshost/fake.host.ibm.com/5858<\/code>", "operationId" : "removeZOShost", "requestBody" : { "required" : false, "content" : { "application/x-www-form-urlencoded" : { "examples" : { "example" : { "value" : "" } }, "schema" : { "type" : "object", "title" : "null Data", "description" : "

                                                              removeZOShost<\/h2>\nThis method will remove a zos connection with the given IP and port\n\n

                                                              Example curl<\/h3>\ncurl -X DELETE -k -H 'Accept-Language: en-US' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/storagedevices/zoshost/fake.host.ibm.com/5858<\/code>" } } } }, "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{{\"msg\":\"IWNR7002I\",\"inserts\":[\"[fakehost.com]:7485\"],\"msgTranslated\":\"IWNR7002I [Mar 1, 2023, 4:31:18 PM] Connection [fakehost.ibm.com]:7485 removed successfully.\",\"timestamp\":1677709878826}}<\/code>" } }, "parameters" : [ { "name" : "hostname", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" }, { "name" : "hostport", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "Port for the zos system" } ] } }, "\/storagedevices/{id}" : { "delete" : { "tags" : [ "HardwareService" ], "description" : "

                                                              removeHardwareMapping<\/h2>\nThis method will remove a storage system connection\n\n

                                                              Example curl<\/h3>\ncurl -X DELETE -k -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i 'https://localhost:9559/CSM/web/storagedevices/DS8000:BOX:2107.KMX61'<\/code>", "operationId" : "removeHardwareMapping", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNH1624I\",\"inserts\":[\"DS8000:BOX:2107.KMX61\"],\"msgTranslated\":\"IWNH1624I [Apr 21, 2020 1:49:49 PM] The storage system DS8000:BOX:2107.KMX61 was successfully removed.\",\"timestamp\":1587494989625}<\/code>" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The id of the storage system to be removed" } ] }, "post" : { "tags" : [ "HardwareService" ], "description" : "

                                                              updateSiteLocationForStorageSystem<\/h2>\nSet a user defined site location for a given storage system\n\n

                                                              Example curl<\/h3>\ncurl -X POST -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i 'https://localhost:9559/CSM/web/storagedevices/DS8000:BOX:2107.GXZ91' --data location=Tucson<\/code>", "operationId" : "updateSiteLocationForStorageSystem", "requestBody" : { "required" : false, "content" : { "application/x-www-form-urlencoded" : { "examples" : { "example" : { "value" : "location=..." } }, "schema" : { "type" : "object", "title" : "null Data", "properties" : { "location" : { "readOnly" : false, "description" : "The name of the location to set on the storage system", "type" : "string" } }, "description" : "

                                                              updateSiteLocationForStorageSystem<\/h2>\nSet a user defined site location for a given storage system\n\n

                                                              Example curl<\/h3>\ncurl -X POST -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i 'https://localhost:9559/CSM/web/storagedevices/DS8000:BOX:2107.GXZ91' --data location=Tucson<\/code>" } } } }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNH1222I\",\"inserts\":[\"DS8000:BOX:2107.GXZ91\",\"Tucson\"],\"msgTranslated\":\"IWNH1222I [Apr 22, 2020 10:05:22 AM] The site location for storage system DS8000:BOX:2107.GXZ91 was successfully changed to Tucson.\",\"timestamp\":1587567922069}<\/code>" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The ID of the storage system to set a site location" } ] } }, "\/storagedevices/{id}/isinuse" : { "get" : { "tags" : [ "HardwareService" ], "description" : "

                                                              isStorageSystemInUse<\/h2>\nReturns true if the storage system is in a session.\n\n

                                                              isStorageSystemInUse<\/h3>\ncurl -X GET -k -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i 'https://localhost:9559/CSM/web/storagedevices/DS8000:BOX:2107.GXZ91/isinuse'<\/code>", "operationId" : "isStorageSystemInUse", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command.\nExample output:\n{\"value\": \"true\"}<\/code>" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Storage system name." } ] } }, "\/storagedevices/{id}/refreshconfig" : { "put" : { "tags" : [ "HardwareService" ], "description" : "

                                                              refreshStorageSystemConfig<\/h2>\nRefreshes the configuration for the given storage system.\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i 'https://localhost:9559/CSM/web/storagedevices/DS8000:BOX:2107.GXZ91/refreshconfig<\/code>", "operationId" : "refreshStorageSystemConfig", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\": \"IWNH1611I\",\n\"inserts\": [\"DS8000:BOX:2107.GXZ91\"],\n\"msgTranslated\": \"IWNH1611I [Apr 21, 2020 1:08:43 PM] A refresh of the storage configuration has completed for the storage device DS8000:BOX:2107.GXZ91.\",\n\"timestamp\": 1587492523136}<\/code>" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The name of the storage system" } ] } }, "\/storagedevices/{id}/sessions" : { "get" : { "tags" : [ "HardwareService" ], "description" : "

                                                              getSystemSessions<\/h2>\nGets all the session names containing copy sets with volumes on the given storage system.\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i 'https://localhost:9559/CSM/web/storagedevices/DS8000:BOX:2107.GXZ91/sessions'<\/code>", "operationId" : "getSystemSessions", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command.\nExample output:\n[\"fcTestSession\", \"sgcTestSession\"]<\/code>" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Storage system name" } ] } }, "\/system/authenticateuser" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              authenticateUser<\/h2>\nThis method will validate that the given user and password has access to the CSM system.\nNOTE: If CSM is setup for LDAP authentication, and external calling system can use this method to validate against the LDAP server.", "operationId" : "authenticateUser", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "authpass", "in" : "query", "schema" : { "type" : "string" }, "description" : "Password for the user to validate" }, { "name" : "authtoken", "in" : "query", "schema" : { "type" : "string" }, "description" : "Not currently supported externally" }, { "name" : "authuser", "in" : "query", "schema" : { "type" : "string" }, "description" : "Username to validate" } ] } }, "\/system/backupdatabase" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              Deprecated. Use GET backupserver.<\/h2>", "operationId" : "getDatabaseBackups", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ ] }, "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              Deprecated. Use PUT backupserver.<\/h2>", "operationId" : "backupDatabase", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ ] } }, "\/system/backupserver" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              getServerBackups<\/h2>\nRetrieves a list of of all server backups.\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: ebdd0df8e67c4317bac177967c3d1a7e' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/backupserver<\/code>", "operationId" : "getServerBackups", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1911I\",\n\"inserts\":[],\n\"msgTranslated\":\"IWNR1911I [May 4, 2020 3:07:31 PM] The database backup list was retrieved successfully.\",\n\"timestamp\":1588622851149,\n\"backups\":[\n{\"backup\":\"https:\\/\\/localhost:9559\\/CSM\\/database\\/backup\\/csmBackup_20200407_130810368.zip\",\"size\":\"1.4 MiB\"},\n{\"backup\":\"https:\\/\\/localhost:9559\\/CSM\\/database\\/backup\\/csmBackup_20200423_095642719.zip\",\"size\":\"1.3 MiB\"},\n{\"backup\":\"https:\\/\\/localhost:9559\\/CSM\\/database\\/backup\\/csmBackup_20200504_150048217.zip\",\"size\":\"1.4 MiB\"},\n{\"backup\":\"https:\\/\\/localhost:9559\\/CSM\\/database\\/backup\\/csmBackup_20190206_143846766.zip\",\"size\":\"919.0 KiB\"},\n{\"backup\":\"https:\\/\\/localhost:9559\\/CSM\\/database\\/backup\\/csmBackup_20200407_130050925.zip\",\"size\":\"1.5 MiB\"},\n{\"backup\":\"https:\\/\\/localhost:9559\\/CSM\\/database\\/backup\\/csmBackup_20200423_093710690.zip\",\"size\":\"1.4 MiB\"},\n{\"backup\":\"https:\\/\\/localhost:9559\\/CSM\\/database\\/backup\\/csmBackup_20200423_094415125.zip\",\"size\":\"1.3 MiB\"}]}<\/code>" } }, "parameters" : [ ] }, "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              backupserver<\/h2>\nCreates a zip backup of the CSM server data that can be used for restoring the server at a later date\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: 59d36fee45db4f818af7b551d2ae7b48' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/backupserver<\/code>", "operationId" : "backupserver", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1905I\",\"resultText\":\"IWNR1905I [May 4, 2020 3:00:49 PM] Backup of internal data store completed successfully. The following file was created: \\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/database\\/backup\\/csmBackup_20200504_150048217.zip\",\"inserts\":[\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/database\\/backup\\/csmBackup_20200504_150048217.zip\"],\"timestamp\":1588622449528}<\/code>" } }, "parameters" : [ ] } }, "\/system/backupserver/download" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              backupdatabase<\/h2>\nCreate and downloads a server backup.\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: ebdd0df8e67c4317bac177967c3d1a7e' -H 'Content-Type: application/octet-stream' https://localhost:9559/CSM/web/system//backupserver/download --output backup.zip\n<\/code>", "operationId" : "backupserverdownload", "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "A file down loaded into the client.\nExample output:\n <\/code>" } }, "parameters" : [ ] } }, "\/system/certificates" : { "post" : { "tags" : [ "SystemService" ], "description" : "

                                                              addCert<\/h2>\nThis method will update the security truststores for the server\n\n

                                                              Example curl<\/h3>\ncurl -X POST -k -H 'Accept-Language: en-US' -H 'Content-Type: multipart/form-data' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/system/certificates --form 'file=@\"ziJziJeMk/csm.cert234 --form 'password=\"passw0rd\"'<\/code>", "operationId" : "addCert2", "requestBody" : { "required" : false, "content" : { "multipart/form-data" : { "examples" : { "example" : { "value" : "" } }, "schema" : { "type" : "object", "title" : "null Data", "description" : "

                                                              addCert<\/h2>\nThis method will update the security truststores for the server\n\n

                                                              Example curl<\/h3>\ncurl -X POST -k -H 'Accept-Language: en-US' -H 'Content-Type: multipart/form-data' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/system/certificates --form 'file=@\"ziJziJeMk/csm.cert234 --form 'password=\"passw0rd\"'<\/code>" } } } }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR4216I\",\"inserts\":[],\"msgTranslated\":\"IWNR4216I [Sep 10, 2025, 01:02:21 PM] The security truststore was successfully updated.\",\"timestamp\":1689282510484}<\/code>" } }, "parameters" : [ ] } }, "\/system/checkcompatibility" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use<\/h2>", "operationId" : "checkCompatibility", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "apiversion", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" }, "description" : "" } ] } }, "\/system/dualcontrol" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              getDualControlStatus<\/h2>\nUse this method to determine if dual control is currently enabled of disabled on the server\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/system/dualcontrol<\/code>", "operationId" : "getDualControlStatus", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output\n{\"msg\":\"IWNR2600I\",\"resultText\":\"IWNR2600I [Apr 24, 2020 12:37:01 PM] Dual Control is enabled for all sessions.\",\"inserts\":[],\"timestamp\":1587749821130}<\/code>" } }, "parameters" : [ ] } }, "\/system/dualcontrol/approve/{id}" : { "post" : { "tags" : [ "SystemService" ], "description" : "

                                                              approveDualControlEvent<\/h2>\nUse this method to approve a dual control event. The user approving the request must be different than the one that created the request\n\n

                                                              Example curl<\/h3>\ncurl -X POST -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/system/dualcontrol/approve/1<\/code>", "operationId" : "approveDualControlEvent", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output\n{\"msg\":\"IWNR2600I\",\"inserts\":[],\"msgTranslated\":\"IWNR2600I [Apr 24, 2020 12:33:11 PM] Dual Control is enabled for all sessions.\",\"timestamp\":1587749591862}<\/code>" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "ID of the request caller wants to approve. ID from the 'requestid' field return from getDualControlEvents." } ] } }, "\/system/dualcontrol/reject/{id}/{comment}" : { "post" : { "tags" : [ "SystemService" ], "description" : "

                                                              rejectDualControlEvent<\/h2>\nUse this method to reject a dual control event created by another user.\n\n

                                                              Example curl<\/h3>\ncurl -X POST -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i 'https://localhost:9559/CSM/web/system/dualcontrol/reject/1/not approved'<\/code>", "operationId" : "rejectDualControlEvent", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output\n{\"msg\":\"IWNR2605I\",\"inserts\":[\"1\",\"csmadmin\",\"not approved\"],\"msgTranslated\":\"IWNR2605I [Apr 23, 2020 12:33:21 PM] Dual Control request 1 was rejected by user csmadmin with the following reason: not approved.\",\"timestamp\":1587663201971}<\/code>" } }, "parameters" : [ { "name" : "comment", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Comment to the creater of the event on why the request was rejected. ID from the 'requestid' field return from getDualControlEvents." }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "ID of the dual control event to be rejected" } ] } }, "\/system/dualcontrol/requests" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              getDualControlEvents<\/h2>\nReturns a list of dual control events waiting for approval or rejection\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/system/dualcontrol/requests<\/code>", "operationId" : "getDualControlEvents", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output\n[{\"summary\":{\"msg\":\"IWNR2608I\",\"resultText\":\"IWNR2608I [Apr 23, 2020 12:26:57 PM] User csmadmin requested to enable Dual Control. The time of the request was 2020-04-23 12:20:53.839-0500.\",\n\"inserts\":[\"csmadmin\",\"2020-04-23 12:20:53.839-0500\"],\n\"timestamp\":1587662817464},\n\"requestinguser\":\"csmadmin\",\n\"requestid\":1,\n\"time\":1587662453839,\n\"type\":\"SET_DUALCONTROL\"}]<\/code>" } }, "parameters" : [ ] } }, "\/system/dualcontrol/{enable}" : { "post" : { "tags" : [ "SystemService" ], "description" : "

                                                              setDualControl<\/h2>\nUse this method to enable or disable dual control on the CSM server.\nNOTE: Enabling of disabling requires an additional user to approve the request before it is enabled or disabled\n\n

                                                              Example curl<\/h3>\ncurl -X POST -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/system/dualcontrol/true<\/code>\ncurl -X POST -k -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/system/dualcontrol/true --data 'mode=sgc_mode'<\/code>", "operationId" : "setDualControl", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output\n{\"msg\":\"IWNR2602W\",\"inserts\":[\"1\",\"csmadmin\",\"marisas-mbp-2.lan1\"],\"msgTranslated\":\"IWNR2602W [Apr 23, 2020 12:20:54 PM] A Dual Control request with ID 1 was added by user csmadmin on server marisas-mbp-2.lan1.\",\"timestamp\":1587662454066}<\/code>" } }, "parameters" : [ { "name" : "enable", "in" : "path", "required" : true, "schema" : { "type" : "boolean" }, "description" : "Set to 'true' if you want to fully enable dual control or 'false' if you want to disable" } ] } }, "\/system/events/listeners/commandstatus" : { "post" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use.<\/h2>", "operationId" : "addCommandStatusListener", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ ] } }, "\/system/events/listeners/commandstatus/{id}" : { "delete" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use.<\/h2>", "operationId" : "removeCommandStatusListener", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "" } ] } }, "\/system/events/listeners/hastatus" : { "post" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use.<\/h2>", "operationId" : "addHAStatusListener", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ ] } }, "\/system/events/listeners/hastatus/{id}" : { "delete" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use.<\/h2>", "operationId" : "removeHAStatusListener", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "" } ] } }, "\/system/events/listeners/logevent" : { "post" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use.<\/h2>", "operationId" : "addLogEventListener", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ ] } }, "\/system/events/listeners/logevent/{id}" : { "delete" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use.<\/h2>", "operationId" : "removeLogEventListener", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "" } ] } }, "\/system/events/listeners/sessioninfo/{session}" : { "post" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use.<\/h2>", "operationId" : "addSessionInfoListener", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "session", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" } ] } }, "\/system/events/listeners/sessioninfo/{session}/{id}" : { "delete" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use.<\/h2>", "operationId" : "removeSessionInfoListener", "responses" : { "204" : { "content" : { "*/*" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "" } ] } }, "\/system/events/listeners/sessionoverview" : { "post" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use.<\/h2>", "operationId" : "addSessionOverviewListener", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ ] } }, "\/system/events/listeners/sessionoverview/{id}" : { "delete" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use.<\/h2>", "operationId" : "removeSessionOverviewListener", "responses" : { "204" : { "content" : { "*/*" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "" } ] } }, "\/system/events/listeners/sessionrpoalert" : { "post" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use.<\/h2>", "operationId" : "addSessionRPOAlertListener", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ ] } }, "\/system/events/listeners/sessoinrpoalert/{id}" : { "delete" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use.<\/h2>", "operationId" : "removeSessionRPOAlertListener", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "" } ] } }, "\/system/events/queues/{id}" : { "delete" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use.<\/h2>", "operationId" : "getEvents", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "" } ] } }, "\/system/ha" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              getHAStatus<\/h2>\nThis method is issued to either the Active or Standby server to retrieve the connection status.\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: ebdd0df8e67c4317bac177967c3d1a7e' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/ha<\/code>\n\n

                                                              HA Status

                                                              \n
                                                            7. Unknown<\/b> - This is the HA status that means the status is currently unknown. <\/li>\n
                                                            8. No Standby<\/b> - This is the HA status that means there is no standby for the active. <\/li>\n
                                                            9. Synchronization Pending<\/b> - This is the HA status that means the servers are in sync pending state. <\/li>\n
                                                            10. Synchronized<\/b> - This is the HA status that means the servers are synchronized and consistent. <\/li>\n
                                                            11. Disconnected<\/b> - This is the HA status that means the servers are disconnected and inconsistent. <\/li>\n
                                                            12. Disconnected Consistent<\/b> - This is the HA status that means the servers are disconnected and consistent. <\/li>\n
                                                            13. Connected<\/b> - This is the HA status taht emans the servers are connected but not yet sync pending. <\/li>\n\n

                                                              HA State

                                                              \n
                                                            14. 0<\/b> - This is the HA state for offline inconsistent. <\/li>\n
                                                            15. 1<\/b> - This is the HA state for synchronized. This means that the HA servers are online consistent. <\/li>\n
                                                            16. 2<\/b> - This is the HA state for offline consistent. This means that the HA servers lost connection while synchronized. <\/li>\n
                                                            17. 3<\/b> - This is the HA state for sync configuring. This means that the HA servers are in the process of synchronization setup. <\/li>\n
                                                            18. 4<\/b> - This is the HA state for sync initializing. This means that the HA servers are in the process of synchronization initialization.<\/li>\n
                                                            19. 5<\/b> - This is the HA state for sync pending. This means that the HA servers are still in the process of becoming consistent.<\/li>\n
                                                            20. 6<\/b> - This is the HA state for when there was a failure synchronizing the HA servers. This means that the HA servers were in the process of becoming consistent when they lost connection with each other. <\/li>\n
                                                            21. 8<\/b> - This is the HA state for when the servers have connected but not yet decided to synchronize. <\/li>", "operationId" : "getHAStatus", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR3048I\",\"resultText\":\"IWNR3048I [May 4, 2020 3:33:02 PM] The high availability status from server kratos.lan was successfully queried.\",\"islocalactive\":true,\"maxsupportedconnections\":1,\"localhaport\":9561,\"serverinfo\":[],\"inserts\":[\"kratos.lan\"],\"timestamp\":1588624382086}<\/code>" } }, "parameters" : [ ] } }, "\/system/ha/reconnect" : { "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              reconnect<\/h2>\nIssues the command to reconnect a disconnected active and standby server", "operationId" : "reconnect", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ ] } }, "\/system/ha/removeHaServer/{haServer}" : { "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              removeHaServer<\/h2>\nThis method removes the alternate CSM server. If issued to the active server the standby will be removed.\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: ebdd0df8e67c4317bac177967c3d1a7e' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/ha/removeHaServer/hostname<\/code>", "operationId" : "removeHaServer", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ { "name" : "haServer", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "hostname of the server to remove" } ] } }, "\/system/ha/setServerAsStandby/{activeServer}" : { "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              setServerAsStandby<\/h2>\nIssue this command to the server that you want to be the standby server.\nSets the server passed in to be the active server. All data on the called server will be replaced with the data from the active server", "operationId" : "setServerAsStandby", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ { "name" : "activeServer", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "IP or hostname of the active server. This method will use the default port." } ] } }, "\/system/ha/setServerAsStandby/{activeServer}/{activeHAPort}" : { "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              setServerAsStandby<\/h2>\nIssue this command to the server that you want to be the standby server.\nSets the server passed in to be the active server. All data on the called server will be replaced with the data from the active server", "operationId" : "setServerAsStandby2", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ { "name" : "activeHAPort", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Port number for the HA connection to the active server" }, { "name" : "activeServer", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "IP or hostname of the active server" } ] } }, "\/system/ha/setStandbyServer/{standbyServer}/{standbyUsername}/{standbyPassword}" : { "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              setStandbyServer<\/h2>\nIssue this command to the server that you want to be the active server.\nSets the server passed in to be the standby server. All data on the passed in server will be replaced with the data from the called server", "operationId" : "setStandbyServer", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ { "name" : "standbyPassword", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Password for the user to create a connection to the standby server" }, { "name" : "standbyServer", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "IP or hostname of the standby server" }, { "name" : "standbyUsername", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Username to create a connection to the standby server" } ] } }, "\/system/ha/setStandbyServer/{standbyServer}/{standbyUsername}/{standbyPassword}/{standByPort}" : { "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              setStandbyServer<\/h2>\nIssue this command to the server that you want to be the active server.\nSets the server passed in to be the standby server. All data on the passed in server will be replaced with the data from the called server", "operationId" : "setStandbyServer2", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ { "name" : "standByPort", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Port to use for connection to the standby server" }, { "name" : "standbyPassword", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Password for the user to create a connection to the standby server" }, { "name" : "standbyServer", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "IP or hostname of the standby server" }, { "name" : "standbyUsername", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Username to create a connection to the standby server" } ] } }, "\/system/ha/takeover" : { "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              haTakeover<\/h2>\nIssues a takeover on the standby server making the standby server an active server.\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: ebdd0df8e67c4317bac177967c3d1a7e' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/ha/takeover<\/code>", "operationId" : "haTakeover", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ ] } }, "\/system/heartbeat" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use<\/h2>", "operationId" : "getHeartbeat", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ ] }, "post" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use<\/h2>", "operationId" : "setHeartbeat", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ ] } }, "\/system/logevents" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              getRecentTopLevelLogEvents<\/h2>\nGet a number of the most recent messages for a given session\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 11931599a4234b8cb5012fd1d7e271f9' -H 'Content-Type: application/x-www-form-urlencoded' -i 'https://localhost:9559/CSM/web/system/logevents?count=5&session=SGC'<\/code>", "operationId" : "getRecentTopLevelLogEvents", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1602I\",\n\"resultText\":\"IWNR1602I [Apr 29, 2020 3:09:17 PM] Successfully retrieved session messages.\",\n\"logevents\":[\n{\"eventnumber\":1588190957730,\n\"eventfilter\":\"com.ibm.csm.common.events.LogEvent\",\n\"createddate\":1588190957730,\n\"session\":\"SGC\",\n\"msgid\":\"IWNR1960I\",\n\"time\":\"Wed Apr 29 15:09:17 CDT 2020\",\n\"id\":215983,\n\"user\":\"Server\",\n\"msgtype\":0,\n\"inserts\":\" SGC Severe Normal\",\n\"timestamp\":1588190652097},\n{\"eventnumber\":1588190957730,\n\"eventfilter\":\"com.ibm.csm.common.events.LogEvent\",\n\"createddate\":1588190957730,\n\"session\":\"SGC\",\n\"msgid\":\"IWNR1960I\",\n\"time\":\"Wed Apr 29 15:09:17 CDT 2020\",\"id\":215916,\n\"user\":\"Server\",\n\"msgtype\":0,\n\"inserts\":\" SGC Severe Normal\",\n\"timestamp\":1588168663725}],\n\"inserts\":[],\n\"timestamp\":1588190957730}<\/code>" } }, "parameters" : [ { "name" : "count", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" }, "description" : "The number of messages to return" }, { "name" : "session", "in" : "query", "schema" : { "type" : "string" }, "description" : "(optional) filter messages on session" } ] }, "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use.<\/h2>", "operationId" : "recordLogMessage", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ ] } }, "\/system/logevents/{eventnumber}" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use<\/h2>", "operationId" : "getLogEventBundle", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "eventnumber", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "description" : "" } ] } }, "\/system/logpackages" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              getLogPackages<\/h2>\nGets a list of log packages and their location on the server\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: ebdd0df8e67c4317bac177967c3d1a7e' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/logpackages<\/code>", "operationId" : "getLogPackages", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n[\n\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/diagnostics\\/CSM-kratos_2020-04-20_13-25-39.jar\",\n\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/diagnostics\\/CSM-kratos_2020-04-30_18-20-10.jar\",\n\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/diagnostics\\/CSM-kratos_2020-05-01_09-31-15.jar\",\n\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/diagnostics\\/CSM-kratos_2020-05-01_09-54-11.jar\",\n\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/diagnostics\\/CSM-kratos_2020-05-04_13-25-06.jar\",\n\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/diagnostics\\/CSM-kratos_2020-05-01_09-33-23.jar\",\n\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/diagnostics\\/CSM-kratos_2020-05-01_09-13-46.jar\",\n\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/diagnostics\\/CSM-kratos_2020-05-01_09-09-23.jar\",\n\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/diagnostics\\/CSM-kratos_2020-05-01_09-12-05.jar\",\n\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/diagnostics\\/CSM-kratos_2020-05-04_13-15-30.jar\"]<\/code>" } }, "parameters" : [ ] }, "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              makeLogPackage<\/h2>\nThis method will package all log files on the server into a .jar file that can be used for support\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: ebdd0df8e67c4317bac177967c3d1a7e' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/logpackages<\/code>", "operationId" : "makeLogPackage", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR6027I\",\"inserts\":[],\"msgTranslated\":\"IWNR6027I [May 4, 2020 3:30:43 PM] The creation of the log package is in progress.\",\"timestamp\":1588624243624}<\/code>" } }, "parameters" : [ ] } }, "\/system/logpackages/synchronous" : { "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              makeLogPackage<\/h2>\nThis method will package all log files on the server into a .jar file that can be used for support - this call is a synchronous call and will not return to caller until package is complete. Call make take awhile\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: ebdd0df8e67c4317bac177967c3d1a7e' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/logpackages/synchronous<\/code>", "operationId" : "makeLogPackageSynchronous", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1198I\",\"inserts\":[\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/diagnostics\\/CSM-kratos_2021-01-05_13-26-18.jar\"],\"msgTranslated\":\"IWNR1198I [Jan 5, 2021 1:26:18 PM] Log packages were successfully created and placed at location \\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/diagnostics\\/CSM-kratos_2021-01-05_13-26-18.jar\",\"timestamp\":1609874778225}<\/code>" } }, "parameters" : [ ] } }, "\/system/logpackages/synchronous/download" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              makeLogPackage<\/h2>\nThis method will package all log files on the server into a .jar file that can be used for support - this call is a synchronous call and will not return to caller until package is complete. Call make take awhile\nThe file created is a .jar file so use a .jar extension when specifying the output file\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: ebdd0df8e67c4317bac177967c3d1a7e' -H 'Content-Type: application/octet-stream' https://localhost:9559/CSM/web/system/logpackages/synchronous/download -o logs.jar <\/code>", "operationId" : "makeLogPackageSynchronous2", "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1198I\",\"inserts\":[\"\\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/diagnostics\\/CSM-kratos_2021-01-05_13-26-18.jar\"],\"msgTranslated\":\"IWNR1198I [Jan 5, 2021 1:26:18 PM] Log packages were successfully created and placed at location \\/Users\\/blead761\\/CSM\\/source\\/CSM-Team\\/workspace\\/Dev-Runtime\\/runtime\\/csm\\/liberty\\/wlp\\/usr\\/servers\\/csmServer\\/diagnostics\\/CSM-kratos_2021-01-05_13-26-18.jar\",\"timestamp\":1609874778225}<\/code>" } }, "parameters" : [ ] } }, "\/system/logpackages/{id}" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use. <\/h2>", "operationId" : "getLogPackages2", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" } ] } }, "\/system/notification/email/alert" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              manageemailalerts<\/h2>\nSet whether the email alert notifications should be enabled or disabled\nWill return whether the request was successful as a JSON result.\n\n*

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: 195eafa9a6ed4a7a80439f5f217aa49c' -H 'Content-Type: application/x-www-form-urlencoded'\n-i 'https://localhost:9559/CSM/web/system/notification/email/alert' --data 'enabled=true'", "operationId" : "getemailalerts", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ ] }, "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              manageemailalerts<\/h2>\nSet whether the email alert notifications should be enabled or disabled\nWill return whether the request was successful as a JSON result.\n\n*

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: 195eafa9a6ed4a7a80439f5f217aa49c' -H 'Content-Type: application/x-www-form-urlencoded'\n-i 'https://localhost:9559/CSM/web/system/notification/email/alert' --data 'enabled=true'", "operationId" : "manageemailalerts", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ ] } }, "\/system/notification/email/recipient" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              getEmailRecipients<\/h2>\nGet the list of e-mail recipients for e-mail alerts\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: ebdd0df8e67c4317bac177967c3d1a7e' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/notification/email/recipients<\/code>", "operationId" : "getEmailRecipients", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output\n{[{ \"sessions\": \"\",\"address\": \"user@ibm.com\",\"type\": \"all\"}, {\"sessions\": \"test2\",\"address\": \"user@ibm.com\",\"type\": \"session\"}, {\"sessions\": \"\",\"address\": \"user@ibm.com\",\"type\": \"config\"}]<\/code>" } }, "parameters" : [ ] }, "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              addEmailRecipient<\/h2>\nAdd an e-mail address to the list of recipients for e-mail alerts. Will return the new list after processing the request.\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: ebdd0df8e67c4317bac177967c3d1a7e' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/notification/email/recipient --data 'address=2342358%40hsgg.com'<\/code>", "operationId" : "addEmailRecipient", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output\n{\"msg\":\"IWNR1720I\",\"addresses\":[\"2342358@hsgg.com\",\"blesdf234asdf@sd.ibm.com\"],\"inserts\":[],\"results\":[{\"msg\":\"IWNR1724I\",\"inserts\":[\"2342358@hsgg.com\",\"ALL_EVENTS\"],\"msgTranslated\":\"IWNR1724I [May 4, 2020 5:02:16 PM] The email recipient 2342358@hsgg.com has been added to category ALL_EVENTS.\",\"timestamp\":1588629736938}],\"msgTranslated\":\"IWNR1720I [May 4, 2020 5:02:16 PM] The email recipient list has been updated.\",\"timestamp\":1588629736938}<\/code>" } }, "parameters" : [ ] } }, "\/system/notification/email/recipient/{address}" : { "delete" : { "tags" : [ "SystemService" ], "description" : "

                                                              removeEmailRecipient<\/h2>\nRemove an e-mail address from the list of recipients for e-mail alerts. Will return the new list after processing the request.\n\n

                                                              Example curl<\/h3>\ncurl -X DELETE -k -H 'X-Auth-Token: ebdd0df8e67c4317bac177967c3d1a7e' -H 'Content-Type: application/x-www-form-urlencoded' -i 'https://localhost:9559/CSM/web/system/notification/email/recipient/23235%40ibm.com'<\/code>", "operationId" : "removeEmailRecipient", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output\n{\"msg\":\"IWNR1720I\",\"addresses\":[],\"inserts\":[],\"results\":[{\"msg\":\"IWNR1723I\",\"inserts\":[\"23235@ibm.com\",\"ALL_EVENTS\"],\"msgTranslated\":\"IWNR1723I [May 4, 2020 5:15:24 PM] The email recipient 23235@ibm.com has been removed from category ALL_EVENTS.\",\"timestamp\":1588630524722}],\"msgTranslated\":\"IWNR1720I [May 4, 2020 5:15:24 PM] The email recipient list has been updated.\",\"timestamp\":1588630524722}<\/code>" } }, "parameters" : [ { "name" : "address", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "The email address to remove from notifications" } ] } }, "\/system/notification/email/recipients" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              getEmailRecipients<\/h2>\nGet the list of e-mail recipients for e-mail alerts\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: ebdd0df8e67c4317bac177967c3d1a7e' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/notification/email/recipients<\/code>", "operationId" : "getAllEmailRecipients", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output\n{\"msg\":\"IWNR1717I\",\"addresses\":[\"emailAddress.com\"],\"inserts\":[],\"msgTranslated\":\"IWNR1717I [May 4, 2020 4:46:41 PM] The recipient list for email alerts.\",\"timestamp\":1588628801155}<\/code>" } }, "parameters" : [ ] }, "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              addEmailRecipients<\/h2>\nAdd an e-mail address to the list of recipients for e-mail alerts.\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: ebdd0df8e67c4317bac177967c3d1a7e' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/notification/email/recipients --data 'addresses=[\"user@ibm.com\"]&alert_type=session&session_names=[\"test\"]'<\/code>", "operationId" : "addEmailRecipients", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output\n{\"msg\":\"IWNR1720I\",\"addresses\":[\"2342358@hsgg.com\",\"blesdf234asdf@sd.ibm.com\"],\"inserts\":[],\"results\":[{\"msg\":\"IWNR1724I\",\"inserts\":[\"2342358@hsgg.com\",\"ALL_EVENTS\"],\"msgTranslated\":\"IWNR1724I [May 4, 2020 5:02:16 PM] The email recipient 2342358@hsgg.com has been added to category ALL_EVENTS.\",\"timestamp\":1588629736938}],\"msgTranslated\":\"IWNR1720I [May 4, 2020 5:02:16 PM] The email recipient list has been updated.\",\"timestamp\":1588629736938}<\/code>" } }, "parameters" : [ ] } }, "\/system/notification/email/smtp" : { "delete" : { "tags" : [ "SystemService" ], "description" : "

                                                              removeSMTPConfiguration<\/h2>\nRemoves the SMTP server configuration for e-mail alerts.", "operationId" : "removeSMTPConfiguration", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ ] }, "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              getSMTPConfiguration<\/h2>\nReturns the SMTP configuration for where email events are sent\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: ebdd0df8e67c4317bac177967c3d1a7e' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/notification/email/smtp<\/code>", "operationId" : "getSMTPConfiguration", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR1715I\",\"server\":\"na.relay.ibm.com\",\"port\":\"25\",\"replyto\":null,\"inserts\":[],\"msgTranslated\":\"IWNR1715I [May 4, 2020 4:40:43 PM] The SMTP server configuration.\",\"timestamp\":1588628443277}<\/code>" } }, "parameters" : [ ] }, "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              setSMTPConfiguration<\/h2>\nSet the SMTP server configuration for e-mail notifications.\nWill return the configuration after processing the request.", "operationId" : "setSMTPConfiguration", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ ] } }, "\/system/notification/email/smtp/auth" : { "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              setSMTPConfiguration<\/h2>\nSet the SMTP server configuration for e-mail notifications.\nWill return the configuration after processing the request.", "operationId" : "setSMTPConfigurationWithAuthentication", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ ] } }, "\/system/notification/email/test" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              testEmailAlert<\/h2>\nSends a test e-mail alert using the current e-mail alert configuration.", "operationId" : "testEmailAlert", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ ] } }, "\/system/notification/email/test/{name}" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              testEmailAlert<\/h2>\nSends a test e-mail alert using the current e-mail alert configuration.", "operationId" : "testUserEmail", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" } ] } }, "\/system/notification/webhooks" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              getAllWebhooks<\/h2>\nReturns all configured webhook notifications.\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 1d506919f0ff4bb08cbb913015a93d08' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/notification/webhooks<\/code>", "operationId" : "getAllWebhooks", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing all configured webhooks.\nExample output:\n[{\"id\":1,\"name\":\"OpsWebhook\",\"description\":\"Send alerts to operations\",\"url\":\"https://example.ibm.com/webhooks/ops\",\"headers\":\"[{\\\"header\\\":\\\"Authorization\\\",\\\"value\\\":\\\"Bearer token\\\"}]\",\"authType\":\"basic\",\"username\":\"webhookUser\",\"password\":\"secret\",\"events\":\"[\\\"ALL_EVENTS\\\"]\"}]<\/code>" } }, "parameters" : [ ] }, "post" : { "tags" : [ "SystemService" ], "description" : "

                                                              insertWebhook<\/h2>\nAdds a webhook notification entry.\n\n

                                                              Example curl<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: 1d506919f0ff4bb08cbb913015a93d08' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/notification/webhooks --data-urlencode 'name=OpsWebhook' --data-urlencode 'description=Send alerts to operations' --data-urlencode 'url=https://example.ibm.com/webhooks/ops' --data-urlencode 'headers=[{\"header\":\"Authorization\",\"value\":\"Bearer token\"},{\"header\":\"Content-Type\",\"value\":\"application/json\"}]' --data-urlencode 'authType=basic' --data-urlencode 'username=webhookUser' --data-urlencode 'password=secret' --data-urlencode 'events=[\"ALL_EVENTS\",\"THREAT_DETECTION\"]'<\/code>", "operationId" : "insertWebhook", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the command result. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR0000I\",\"inserts\":[],\"msgTranslated\":\"Webhook was added successfully.\",\"timestamp\":1714428000000}<\/code>" } }, "parameters" : [ ] }, "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              updateWebhook<\/h2>\nUpdates a webhook notification entry.\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: 1d506919f0ff4bb08cbb913015a93d08' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/notification/webhooks --data-urlencode 'id=2' --data-urlencode 'name=SessionWebhook' --data-urlencode 'description=Session alert webhook' --data-urlencode 'url=https://example.ibm.com/webhooks/session' --data-urlencode 'headers=[{\"header\":\"Authorization\",\"value\":\"Bearer new-token\"}]' --data-urlencode 'authType=basic' --data-urlencode 'username=sessionUser' --data-urlencode 'password=sessionSecret' --data-urlencode 'events=[\"SESSION_STATE_CHANGE\",\"SESSION_RPO_THRESHOLD_ALERTS\"]'<\/code>", "operationId" : "updateWebhook", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the command result. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR0000I\",\"inserts\":[],\"msgTranslated\":\"Webhook was updated successfully.\",\"timestamp\":1714428000000}<\/code>" } }, "parameters" : [ ] } }, "\/system/notification/webhooks/test" : { "post" : { "tags" : [ "SystemService" ], "description" : "

                                                              testWebhook<\/h2>\nSends a test webhook notification using the supplied webhook configuration.\nThis call does not require the webhook to already exist in the database.\n\n

                                                              Example curl<\/h3>\ncurl -X POST -k -H 'X-Auth-Token: 1d506919f0ff4bb08cbb913015a93d08' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/notification/webhooks/test --data-urlencode 'name=TestWebhook' --data-urlencode 'description=Temporary webhook test' --data-urlencode 'url=https://example.ibm.com/webhooks/test' --data-urlencode 'headers=[{\"header\":\"Authorization\",\"value\":\"Bearer token\"},{\"header\":\"Content-Type\",\"value\":\"application/json\"}]' --data-urlencode 'authType=basic' --data-urlencode 'username=testUser' --data-urlencode 'password=testSecret' --data-urlencode 'events=[\"ALL_EVENTS\"]'<\/code>", "operationId" : "testWebhook", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the command result. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR0000I\",\"inserts\":[],\"msgTranslated\":\"Webhook test completed successfully.\",\"timestamp\":1714428000000}<\/code>" } }, "parameters" : [ ] } }, "\/system/notification/webhooks/test/{id}" : { "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              testwebhookbyid<\/h2>\nTests a given webhook\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: 1d506919f0ff4bb08cbb913015a93d08' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/notification/webhooks/10'<\/code>", "operationId" : "testwebhookbyid", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the command result. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR0000I\",\"inserts\":[],\"msgTranslated\":\"Webhook was tested successfully.\",\"timestamp\":1714428000000}<\/code>" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "Unique webhook id to test." } ] } }, "\/system/notification/webhooks/{eventCategory}" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              getWebhooksForEventCategory<\/h2>\nReturns configured webhooks for the requested alert category.\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 1d506919f0ff4bb08cbb913015a93d08' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/notification/webhooks/SESSION_STATE_CHANGE<\/code>", "operationId" : "getWebhooksForEventCategory", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the matching webhooks.\nExample output:\n[{\"id\":2,\"name\":\"SessionWebhook\",\"description\":\"Session alerts only\",\"url\":\"https://example.ibm.com/webhooks/session\",\"headers\":\"[{\\\"header\\\":\\\"Content-Type\\\",\\\"value\\\":\\\"application/json\\\"}]\",\"authType\":\"none\",\"username\":\"\",\"password\":\"\",\"events\":\"[\\\"SESSION_STATE_CHANGE\\\",\\\"SESSION_RPO_THRESHOLD_ALERTS\\\"]\"}]<\/code>" } }, "parameters" : [ { "name" : "eventCategory", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "Alert category string to filter by. Supported values are ALL_EVENTS, SESSION_STATE_CHANGE, SESSION_RPO_THRESHOLD_ALERTS, CONFIGURATION_CHANGES, COMMUNICATION_FAILURES, UNEXPECTED_SEVERE_STATUS, ACTIVE_STANDBY_CONNECTED, ACTIVE_STANDBY_DISCONNECTED, PATHING_ALERTS, SCHEDULED_TASK_COMPLETED, SCHEDULED_TASK_FAILED, and THREAT_DETECTION." } ] } }, "\/system/notification/webhooks/{id}" : { "delete" : { "tags" : [ "SystemService" ], "description" : "

                                                              deleteWebhook<\/h2>\nDeletes a webhook notification entry.\n\n

                                                              Example curl<\/h3>\ncurl -X DELETE -k -H 'X-Auth-Token: 1d506919f0ff4bb08cbb913015a93d08' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/notification/webhooks/2<\/code>", "operationId" : "deleteWebhook", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the command result. 'I' = successful, 'W' = warning, 'E' = error\nExample output:\n{\"msg\":\"IWNR0000I\",\"inserts\":[],\"msgTranslated\":\"Webhook was deleted successfully.\",\"timestamp\":1714428000000}<\/code>" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "description" : "Unique webhook id to delete." } ] } }, "\/system/properties/{file}/{property}/{value}" : { "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              setProperty<\/h2>\nThis method changes to system settings files for the server.\nNOTE: The server may need to be restarted for changes to take effect depending on the property\n\n

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: ebdd0df8e67c4317bac177967c3d1a7e' -H 'Content-Type: application/x-www-form-urlencoded' -i https://localhost:9559/CSM/web/system/properties/server/csm.server.validate_sources_for_primary_migration.sessionname/false<\/code>", "operationId" : "setProperty", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ { "name" : "file", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "name of the file to change. Avaible options are \"server\" (rmserver.properties), \"bootstrap\" (bootstrap.properties), \"essclient\" (essclient.properties), \"zosclient\" (zosclient.properties)" }, { "name" : "property", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "the name of the property that you want to add or udpate" }, { "name" : "value", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "the value for the property you want to set" } ] } }, "\/system/security/auth/sync" : { "post" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use.<\/h2>", "operationId" : "syncAuthService", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ ] } }, "\/system/security/connection/zos/encryption/disable" : { "post" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use.<\/h2>", "operationId" : "disableZOSConnectionEncryption", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ ] } }, "\/system/security/connection/zos/encryption/enable" : { "post" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use.<\/h2>", "operationId" : "enableZOSConnectionEncryption", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ ] } }, "\/system/servername" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              getUserDefinedServerName<\/h2>\nGet the user defined name for the server. If the servername hasn't been set by the user then null will be returned\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: ebdd0df8e67c4317bac177967c3d1a7e' -H 'Content-Type: application/octet-stream' https://localhost:9559/CSM/web/system//servername\n<\/code>", "operationId" : "getUserDefinedServerName", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "json result containing \"serverName\"\n <\/code>" } }, "parameters" : [ ] }, "post" : { "tags" : [ "SystemService" ], "operationId" : "setUserDefinedServerName", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ ] } }, "\/system/sessiontypes" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              getsessiontypes<\/h2>\nReturns the list of available copy types. Use the \"shortname\" on the createsession API to create a session\n\n

                                                              Example curl:<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: e6bd510f2032461b8fe4d513d8bd15f6' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/system/sessiontypes<\/code>", "operationId" : "getSessionTypes", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON string representing a list of all available session types. Use \"shortname\" value when creating a session\n[{\"name\":\"FlashCopy\",\"shortname\":\"FC\"},{\"name\":\"Snapshot\",\"shortname\":\"Snapshot\"},{\"name\":\"Safeguarded Copy\",\"shortname\":\"SGC\"},{\"name\":\"Metro Mirror Single Direction\",\"shortname\":\"MMBasic\"},{\"name\":\"Metro Mirror Failover\\/Failback\",\"shortname\":\"MM\"},{\"name\":\"Metro Mirror Failover\\/Failback w\\/ Practice\",\"shortname\":\"MMPracticeOneSite\"},{\"name\":\"Metro Mirror Failover\\/Failback w\\/ Practice\",\"shortname\":\"MMPracticeOneSiteSVC\"},{\"name\":\"Metro Mirror Failover\\/Failback\",\"shortname\":\"MMXIV\"},{\"name\":\"Global Mirror Single Direction\",\"shortname\":\"GMBasic\"},{\"name\":\"Global Mirror Single Direction\",\"shortname\":\"GMBasicSVC\"},{\"name\":\"Global Mirror Failover\\/Failback\",\"shortname\":\"GM\"},{\"name\":\"Global Mirror Failover\\/Failback\",\"shortname\":\"GMSVC\"},{\"name\":\"Global Mirror Failover\\/Failback\",\"shortname\":\"GMXIV\"},{\"name\":\"Global Mirror Failover\\/Failback w\\/ Practice\",\"shortname\":\"GMPracticeOneSiteSVC\"},{\"name\":\"Global Mirror Failover\\/Failback w\\/ Practice\",\"shortname\":\"GMPracticeOneSite\"},{\"name\":\"Global Mirror Either Direction w\\/ Two Site Practice\",\"shortname\":\"GMPracticeTwoSite\"},{\"name\":\"Global Mirror Failover\\/Failback w\\/ Change Volumes\",\"shortname\":\"GMCVSVC\"},{\"name\":\"Global Mirror Either Direction\",\"shortname\":\"GMTwoSite\"},{\"name\":\"Metro Global Mirror\",\"shortname\":\"MGM\"},{\"name\":\"Metro Global Mirror w\\/ Practice\",\"shortname\":\"MGMPracticeOneSite\"},{\"name\":\"Metro Mirror - Metro Mirror\",\"shortname\":\"MT_MM_MM\"},{\"name\":\"Metro Mirror - Global Mirror\",\"shortname\":\"MT_MM_GM\"},{\"name\":\"Metro Mirror - Global Mirror w\\/ Practice\",\"shortname\":\"MT_MM_GMPractice\"},{\"name\":\"Metro Mirror - Global Mirror w\\/ Site 3 Global Mirror\",\"shortname\":\"MT_MM_GM_Site3GM\"},{\"name\":\"Metro Mirror - Global Mirror w\\/ Site 4 Replication\",\"shortname\":\"MT_MM_GM_4Site\"},{\"name\":\"Metro Mirror - Global Mirror\",\"shortname\":\"MT_MM_GM_XIV\"},{\"name\":\"Metro Mirror - Metro Mirror w\\/ Site 4 Replication\",\"shortname\":\"MT_MM_MM_4Site\"}]<\/code>" } }, "parameters" : [ ] } }, "\/system/storagesystems/{id}" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use<\/h2>", "operationId" : "getSessionsByStorageSystem", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" }, { "name" : "activesessions", "in" : "query", "schema" : { "type" : "boolean" }, "description" : "" } ] } }, "\/system/user/getemail/{name}" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              getemail<\/h2>\nGet the e-mail address for a given user.\nWill return whether the request was successful as a JSON result.\n\n

                                                              Example curl<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: 1d506919f0ff4bb08cbb913015a93d08' -H 'Content-Type: application/x-www-form-urlencoded' -i\n'https://localhost:9559/CSM/web/system/user/getemail/csmadmin'", "operationId" : "getEmail", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" } ] } }, "\/system/user/getemails" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                              Not currently supported for external use.<\/h2>", "operationId" : "getEmails", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ ] } }, "\/system/user/setemail" : { "put" : { "tags" : [ "SystemService" ], "description" : "

                                                              setemail<\/h2>\nSet the e-mail address for a given user.\nWill return whether the request was successful as a JSON result.\n\n*

                                                              Example curl<\/h3>\ncurl -X PUT -k -H 'X-Auth-Token: 195eafa9a6ed4a7a80439f5f217aa49c' -H 'Content-Type: application/x-www-form-urlencoded'\n-i 'https://localhost:9559/CSM/web/system/user/setemail' --data 'name=csm%20admin&email=example@us.ibm.com'", "operationId" : "setemail", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing the result of the command. 'I' = successful, 'W' = warning, 'E' = error" } }, "parameters" : [ ] } }, "\/system/users" : { "get" : { "tags" : [ "SystemService" ], "operationId" : "getUsers", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ ] } }, "\/system/v1/personalaccesstokens" : { "post" : { "tags" : [ "SystemService" ], "description" : "

                                                              requestPersonalAccessToken<\/h2>\nThis method allows a REST caller to request a Personal Access Token for application automation.\nThe passed in username and password will be used for authentication and if authenticated the resulting json will contain the token to use on all subsequent calls.\nNOTE: Unlike temporary tokens, personal access tokens are stored in the database and persist across server restarts. They expire based on the specified expiration days.\n\n

                                                              Example curl:<\/h3>\ncurl -X POST -k -H 'Accept-Language: en-US' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/system/v1/personalaccesstokens --data 'username=csmadmin&password=csm&name=MyApp&expirationDays=90'<\/code>\n\n

                                                              Principal JSON keys returned in response <\/h3>\n
                                                                \n
                                                              1. msg<\/b> - The message number for the result. 'I' = successful, 'W' = warning, 'E' = error <\/li>\n
                                                              2. token<\/b> - The personal access token authentication String that can be used with the X-Auth-Token header on subsequent REST calls for authentication <\/li>\n
                                                              3. user<\/b> - The username for whom the token was created <\/li>\n<\/ol>", "operationId" : "requestPersonalAccessToken", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing AuthenticationResult object for the request. The final character of the 'msg' key indicates completion status for the request. 'I' = successful, 'W' = warning, 'E' = error\n\n{ \"msg\": \"IWNR4005I\",\n\"inserts\": [\"csmadmin\"],\n\"user\": \"csmadmin\",\n\"msgTranslated\": \"IWNR4005I [May 22, 2026 3:48:14 PM] Successfully authenticated user {1}.\",\n\"timestamp\": 1716403694513,\n\"token\": \"Xy9aB3cD4eF5gH6iJ7kL8mN9oP0qR1sT2uV3wX4yZ5\"\n}<\/code>" } }, "parameters" : [ ] } }, "\/system/v1/tokens" : { "post" : { "tags" : [ "SystemService" ], "description" : "

                                                                requestToken<\/h2>\nThis method allows a REST caller to request a token String to use for authentication.\nThe passed in username and password will be used for authentication and if authenticated the resulting json will contain the token to use on all subsequent calls.\nNOTE: The token provided will expire automatically and a new token will be necessary after a default of two hours.\n\n

                                                                Example curl:<\/h3>\ncurl -X POST -k -H 'Accept-Language: en-US' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/system/v1/tokens --data 'username=csmadmin&password=csm'<\/code>\n\n

                                                                Principal JSON keys returned in response <\/h3>\n
                                                                  \n
                                                                1. msg<\/b> - The message number for the result. 'I' = successful, 'W' = warning, 'E' = error <\/li>\n
                                                                2. token<\/b> - The token authentication String that can be used with the X-Auth-Token header on subsequent REST calls for authentication <\/li>\n
                                                                3. created_time_milliseconds<\/b> - Time in milliseconds since January 1, 1970, 00:00:00 GMT when the token was created <\/li>\n
                                                                4. expire_time_milliseconds<\/b> - Time in milliseconds since January 1, 1970, 00:00:00 GMT when the token will expire <\/li>\n<\/ol>", "operationId" : "requestToken", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing CmdResult object for the request. The final character of the 'msg' key indicates completion status for the request. 'I' = successful, 'W' = warning, 'E' = error\n\n{ \"msg\": \"IWNR4005I\",\n\"expire_time_milliseconds\": 1586548094513,\n\"inserts\": [\"csmadmin\"],\n\"user\": \"csmadmin\",\n\"msgTranslated\": \"IWNR4005I [Apr 10, 2020 12:48:14 PM] Successfully authenticated user {1}.\",\n\"created_time_milliseconds\": 1586540894513,\n\"timestamp\": 1586540894513,\n\"token\": \"008d4b1e4dd54501a537340842e7b4d7\"\n}<\/code>" } }, "parameters" : [ ] } }, "\/system/version" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                                  version<\/h2>\nThis method returns the current version of the CSM server\n\n

                                                                  Example curl:<\/h3>\ncurl -X GET -k -H 'Accept-Language: en-US' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Authorization: Basic Y3NtYWRtaW46Y3Nt' -i https://localhost:9559/CSM/web/system/version<\/code>", "operationId" : "checkCompatibility2", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON String representing version data\n\n{\"version\":\"6.3.1\"}<\/code>" } }, "parameters" : [ ] } }, "\/system/volcounts" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                                  getvolcounts<\/h2>\nReturns the counts of volumes managed by CSM.\n\n

                                                                  Example curl:<\/h3>\ncurl -X GET -k -H 'X-Auth-Token: e6bd510f2032461b8fe4d513d8bd15f6' -H 'Content-Type: application/x-www-form-urlencoded' -i https://hostname:9559/CSM/web/system/volcounts<\/code>", "operationId" : "getVolCounts", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "JSON string representing a list of all available session types. Use \"shortname\" value when creating a session\n[{\"totalvolsnotinsessions\":0,\"rcprodcapacity\":\"407.5 MiB\",\"totalvolsinsessions\":30,\"prodcapacity\":\"407.5 MiB\",\"sgcprodvols\":0,\"totalvolsdiscovered\":30,\"fcprodcapacity\":\"407.5 MiB\",\"tgtvols\":24,\"sgcprodcapacity\":\"0.0 KiB\",\"fcprodvols\":6,\"prodvols\":6,\"rcprodvols\":6,\"tgtcapacity\":\"1.6 GiB\"}]<\/code>" } }, "parameters" : [ ] } }, "\/system/volumes" : { "post" : { "tags" : [ "SystemService" ], "description" : "

                                                                  Not currently supported for external use<\/h2>", "operationId" : "getSessionsByVolume", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ ] } }, "\/system/volumes/{id}" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                                  Not currently supported for external use<\/h2>", "operationId" : "getSessionInfoByVolume", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" }, { "name" : "sessiontypes", "in" : "query", "schema" : { "type" : "string" }, "description" : "" } ] } }, "\/system/volumes/{id}/isinuse" : { "get" : { "tags" : [ "SystemService" ], "description" : "

                                                                  Not currently supported for external use<\/h2>", "operationId" : "isVolumeInUse", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "description" : "", "type" : "string" } } }, "description" : "" } }, "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" }, "description" : "" } ] } } } }