list

dpsctl resource-group list Usage Guide

List resource groups.

Usage

dpsctl resource-group list

Flags

Includes global dpsctl options.

  --active    optional filter by active state (true/false)
  --help, -h  show help

Examples

Basic Usage

$ dpsctl resource-group list
{
  "resource_groups": [
    {
      "group_name": "test",
      "external_id": 1,
      "activation_status": "inactive",
      "policy_name": "",
      "resource_names": [],
      "properties": {},
      "prs_enabled": true,
      "dpm_enable": true,
      "priority": 0,
      "policy_bundle": "MaxP"
    },
    {
      "group_name": "test-2",
      "external_id": 2,
      "activation_status": "inactive",
      "policy_name": "",
      "resource_names": [
        "node001",
        "node002",
        "node003"
      ],
      "properties": {
        "prs-enabled": false
      },
      "prs_enabled": false,
      "dpm_enable": true,
      "priority": 0,
      "policy_bundle": "MaxQ"
    },
    {
      "group_name": "test-3",
      "external_id": 3,
      "activation_status": "inactive",
      "policy_name": "",
      "resource_names": [
        "node004"
      ],
      "properties": {
        "prs-enabled": true
      },
      "prs_enabled": true,
      "dpm_enable": true,
      "priority": 0,
      "policy_bundle": "MaxLPS"
    }
  ]
}

The policy_bundle field is the bundle selection persisted on each resource group. Use it to verify the create-time selection. An empty value means no bundle is configured. The policy_name field is retained for API compatibility and is not the policy bundle name. The Go CLI bundle-only create path leaves it empty.

Filter on active status

dpsctl -H localhost -p 8080 rg list --active
{
  "resource_groups": [
    {
      "group_name": "test-2",
      "external_id": 2,
      "activation_status": "active",
      "policy_name": "",
      "resource_names": [
        "node003",
        "node002",
        "node001"
      ],
      "properties": {},
      "prs_enabled": true,
      "dpm_enable": true,
      "priority": 0,
      "policy_bundle": "MaxQ"
    },
    {
      "group_name": "test-3",
      "external_id": 3,
      "activation_status": "active",
      "policy_name": "",
      "resource_names": [
        "node004"
      ],
      "properties": {},
      "prs_enabled": true,
      "dpm_enable": true,
      "priority": 0,
      "policy_bundle": "MaxLPS"
    }
  ]
}

If --active is omitted, all resource groups are listed. The priority field is the stored resource group priority. 0 is the default and the highest precedence. Refer to Resource Group Priority.

$ dpsctl resource-group list --active=false
{
  "resource_groups": [
    {
      "group_name": "test",
      "external_id": 1,
      "activation_status": "inactive",
      "policy_name": "",
      "resource_names": [],
      "properties": {
        "prs-enabled": false
      },
      "prs_enabled": false,
      "dpm_enable": true,
      "priority": 0,
      "policy_bundle": "MaxP"
    }
  ]
}