PolicyAttributes

Attributes of a NetBackup backup policy

BackupData ProtectionDisaster RecoveryEnterpriseRecoveryStorage

Properties

Name	Type	Description
policyName	string	Unique name of the policy
policyType	string	The policy type defining the type of backup
active	boolean	Whether the policy is currently active
effectiveDate	string	Date and time the policy becomes effective
snapshotMethodArgs	string	Arguments for snapshot method if applicable
backupCopies	object
priority	integer	Job priority for this policy
keyword	string	Keyword tag for the policy
dataClassification	string	Data classification associated with this policy

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PolicyAttributes",
  "title": "PolicyAttributes",
  "type": "object",
  "description": "Attributes of a NetBackup backup policy",
  "properties": {
    "policyName": {
      "type": "string",
      "description": "Unique name of the policy",
      "example": "example_value"
    },
    "policyType": {
      "type": "string",
      "description": "The policy type defining the type of backup",
      "enum": [
        "Standard",
        "MS-Windows",
        "VMware",
        "Oracle",
        "MS-SQL-Server",
        "MS-Exchange-Server",
        "Hyper-V",
        "Kubernetes",
        "BigData",
        "CloudObject",
        "NAS-Data-Protection",
        "Universal-Share"
      ],
      "example": "Standard"
    },
    "active": {
      "type": "boolean",
      "description": "Whether the policy is currently active",
      "example": true
    },
    "effectiveDate": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time the policy becomes effective",
      "example": "2026-01-15T10:30:00Z"
    },
    "snapshotMethodArgs": {
      "type": "string",
      "description": "Arguments for snapshot method if applicable",
      "example": "example_value"
    },
    "backupCopies": {
      "type": "object",
      "properties": {
        "copies": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "copyNumber": {
                "type": "integer",
                "description": "Copy number (1 for primary, 2+ for copies)"
              },
              "storageUnit": {
                "type": "string",
                "description": "Storage unit name for this copy"
              },
              "retentionPeriod": {
                "type": "object",
                "properties": {
                  "value": {
                    "type": "integer",
                    "description": "Retention period value"
                  },
                  "unit": {
                    "type": "string",
                    "description": "Time unit for retention",
                    "enum": [
                      "DAYS",
                      "WEEKS",
                      "MONTHS",
                      "YEARS",
                      "INFINITE"
                    ]
                  }
                }
              }
            }
          }
        }
      },
      "example": "example_value"
    },
    "priority": {
      "type": "integer",
      "description": "Job priority for this policy",
      "minimum": 0,
      "maximum": 99999,
      "example": 10
    },
    "keyword": {
      "type": "string",
      "description": "Keyword tag for the policy",
      "example": "example_value"
    },
    "dataClassification": {
      "type": "string",
      "description": "Data classification associated with this policy",
      "example": "example_value"
    }
  }
}