Filesystems/{filesystemName}/filesets/{filesetName}/cos/policy: DELETE

Deletes a user defined policy.

Availability

Available on all IBM Storage Scale editions.

Description

The DELETE filesystems/{filesystemName}/filesets/{filesetName}/cos/policy command deletes a user defined policy. For more information on deleting policies, see mmafmcosctl command.

Request URL

Use this URL to delete a policy:
https://management API host:port/scalemgmt/v2/filesystems/{filesystemName}/filesets/{filesetName}/cos/policy
where:
filesystems/filesystemName
Specifies the file system to which the fileset belongs. Required.
cos/policy
Specifies the resource that must be deleted.

Request parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of request parameters
Parameter name Description and applicable keywords Required/optional
filesystemName The file system name. You can also use keywords such as :all:, :all_local:, or :all_remote: Required.
filesetName The fileset name. This is the path of the fileset. Required.
path The file path relative to file system's mount point. The path of the file or directory is specified with forward slashes (/). For example: mnt/gpfs0/rest01. The forward slashes in the path are encoded to %2F in the request URL. Required.

Request data

No request data.

Response data

{
    "status": {
      "code":ReturnCode",
      "message":"ReturnMessage"
   },
   jobs: [
      {
         "result":"", 
           { 
             "commands":"String",
             "progress":"String,
             "exitCode":"Exit code",
             "stderr":"Error",
             "stdout":"String",
           },
         "request":" ",
           {
             "type":"{GET | POST | PUT | DELETE}",
             "url":"URL",
             "data":""",
           }
         "jobId":"ID",
         "submitted":"Time",
         "completed":Time",
         "status":"Job status",
         }   
        ],
   }
For more information about the fields in the following data structures, see the links at the end of this topic.
"status":
Return status.
"message": "ReturnMessage",
The return message.
"code": ReturnCode
The return code.
"jobs":
An array of elements that describe jobs. Each element describes one job.
"result"
"commands":"String'
Array of commands that are run in this job.
"progress":"String'
Progress information for the request.
"exitCode":"Exit code"
Exit code of command. Zero is success, nonzero denotes failure.
"stderr":"Error"
CLI messages from stderr.
"stdout":"String"
CLI messages from stdout.
"request"
"type":"{GET | POST | PUT | DELETE}"
HTTP request type.
"url":"URL"
The URL through which the job is submitted.
"data":" "
Optional.
"jobId":"ID",
The unique ID of the job.
"submitted":"Time"
The time at which the job was submitted.
"completed":Time"
The time at which the job was completed.
"status":"RUNNING | COMPLETED | FAILED"
Status of the job.

Examples

The following example deletes a user defined policy in the fileset afmkagui.

Request data: 
curl -k -u admin:admin001 -X DELETE --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/filesystems/FS1/filesets/afmkagui/cos/policy
Response data:
Note: In the JSON data that is returned, the return code indicates whether the command is successful. The response code 200 indicates that the command successfully retrieved the information. Error code 400 represents an invalid request and 500 represents internal server error. 
{ 
"jobs": [ { 
 "jobId": 1000000000029, 
 "status": "RUNNING",
 "submitted": "2022-10-20 06:51:35,368", 
 "completed": "N/A", 
 "runtime": 11,
  }
 ]  
"request": { 
"data": { "path": "/gpfs/fs1/afmkagui", "policyPath": "/root/policy2", "rule": "RULE EXTERNAL LIST 'dirtyFiles'", "add": false 
}, 
"type": "DELETE", 
"url": "/scalemgmt/v2/filesystems/fs1/filesets/afmkagui/cos/policy" }, 
"result": {}, 
"pids": [] } ], 
"status": { 
"code": 202, 
"message": "The request was accepted for processing." 
} }
]