security iam task list

Lists a list of IAM policy tasks with their status.

You can use iam task list command to fetch a list of IAM policy- identity (user,group, and/or role) associations on a fabric.

The task ID comprises three digits that are separated by period, for example, 2.0.0. Each digit represents the following:

  • The first digit represents the IAM policy ID in the sequence of policies being enforced at a given time,
  • The second digit represents the statement number in the IAM policy.
  • The third digit represents the resource number in the statement.
    NOTE
    The numbering for the statement number and resource number starts at 0. If there are multiple IAM policies being enforced on multiple objects at the same time, the numbering is implemented based on the sequence of policy implementation, and in turn sequence of statements in a policy and the sequence of resources mentioned in the policy statements.

You can filter tasks based on cluster name, policy name and/or task status.

IMPORTANT
Supported values for task status are NotStarted, InProgress, Success, Error, Aborted.

Syntax

CLI
IMPORTANT
The information is displayed only for identity (IAM) policies that have the status Enforcing, Enforced, Disarming, or Disarmed only. 
maprcli security iam task list [ -cluster <Cluster Name> ]  [ -policy <Policy Name> ]  [ -status <Task Status> ]
REST
Request Type GET
Request URL 
http[s]://<host>:<port>/rest/iam/task/list?<parameters>

Parameters

Parameter Description
type (Optional) The resource type. You must use one parameter from: cluster, policy or status to list the tasks.

Format: [ -cluster <Cluster Name> | -policy <Policy Name> | -status <Task Status> ]

Examples

List current tasks

CLI
maprcli security iam task list -json
{
        "timestamp":1726151803004,
        "timeofday":"2024-09-12 07:36:43.004 GMT-0700 AM",
        "status":"OK",
        "total":6,
        "data":[
                {
                        "Id":"2.0.0",
                        "Resource":"urn:default:secondary:volume:vol-1",
                        "Status":"Success"
                },
                {
                        "Id":"2.1.0",
                        "Resource":"urn:default:primary:volume:vol-2",
                        "Status":"NotStarted"
                },
                {
                        "Id":"1.0.0",
                        "Resource":"urn:default:primary:volume:vol-1",
                        "Status":"Success"
                },
                {
                        "Id":"1.1.0",
                        "Resource":"urn:default:secondary:volume:vol-2",
                        "Status":"Success"
                },
                {
                        "Id":"2.2.0",
                        "Resource":"urn:default:primary:volume:vol-3",
                        "Status":"InProgress"
                },
                {
                        "Id":"1.2.0",
                        "Resource":"urn:default:secondary:volume:vol-3",
                        "Status":"Aborted"
                }
        ]
}

REST

curl -u <username> -X GET https://server.sj.us:8443/rest/security/iam/task/list

Filtering the Tasks

You can filter from all resource tasks associated with a cluster. For example:

  • Filter by Cluster
    CLI
    maprcli security iam task list -cluster primary -json
{
   "timestamp":1726152058255,
   "timeofday":"2024-09-12 07:40:58.255 GMT-0700 AM",
   "status":"OK",
   "total":3,
   "data":[
      {
         "Id":"2.1.0",
         "Resource":"urn:default:primary:volume:vol-2",
         "Status":"NotStarted"
      },
      {
         "Id":"1.0.0",
         "Resource":"urn:default:primary:volume:vol-1",
         "Status":"Success"
      },
      {
         "Id":"2.2.0",
         "Resource":"urn:default:primary:volume:vol-3",
         "Status":"InProgress"
      }
   ]
}
    REST
    curl -u <username> -X GET https://server.sj.us:8443/rest/security/iam/task/list?cluster=primary
  • Filter and list tasks by the identity policy 'policy1'

    CLI

    sudo maprcli security iam task list -policy policy1 -json
{
        "timestamp":1738060289052,
        "timeofday":"2025-01-28 02:31:29.052 GMT-0800 AM",
        "status":"OK",
        "total":1,
        "data":[
                {
                        "Id":"1.0.0",
                        "Update":"False",
                        "Resource":"urn:default:cluster1:volume:a5",
                        "Status":"NotStarted"
                }
        ]
}

    REST

    curl -u <username> -X GET https://server.sj.us:8443/rest/security/iam/task/list?policy=policy1
  • Filter and list the tasks by Task Status 'success'

    CLI

    maprcli security iam task list -status Success -json
{
   "timestamp":1726151803004,
   "timeofday":"2024-09-12 07:36:43.004 GMT-0700 AM",
   "status":"OK",
   "total":6,
   "data":[
      {
         "Id":"2.0.0",
         "Resource":"urn:default:secondary:volume:vol-1",
         "Status":"Success"
      },
      {
         "Id":"1.0.0",
         "Resource":"urn:default:primary:volume:vol-1",
         "Status":"Success"
      },
      {
         "Id":"1.1.0",
         "Resource":"urn:default:secondary:volume:vol-2",
         "Status":"Success"
      }
   ]
}

    REST

    curl -u <username> -X GET https://server.sj.us:8443/rest/security/iam/task/list?status=Success