Vault Credentials Schema

Available Languages

Download Options

  • PDF     (10.4 KB)
    View with Adobe Reader on a variety of devices
  • ePub     (76.7 KB)
    View in various apps on iPhone, iPad, Android, Sony Reader, or Windows Phone
  • Mobi (Kindle)     (61.5 KB)
    View on Kindle device or Kindle app on multiple devices
Updated:December 5, 2025
Document ID:CX225393

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Contents


{
  "type": "object",
  "properties": {
    "targetIp": {
      "type": "string",
      "description": "IP address or hostname of the target device(s). Supports wildcards (e.g., 5.0.*.*)."
    },
    "credentials": {
      "type": "object",
      "description": "Object containing protocol-specific credentials.",
      "properties": {
        "snmpv2c": {
          "type": "object",
          "description": "SNMPv2c credentials.",
          "properties": {
            "read": {
              "type": "string",
              "description": "SNMP Read Community"
            }
          },
          "required": ["read"]
        },
        "snmpv3": {
          "type": "object",
          "description": "SNMPv3 credentials.",
          "properties": {
            "user": {
              "type": "string",
              "description": "SNMPv3 User"
            },
            "authAlgorithm": {
              "type": "string",
              "description": "Authentication Algorithm (optional)"
            },
            "authPassword": {
              "type": "string",
              "description": "Authentication Password (required if authAlgorithm is provided)"
            },
            "privacyAlgorithm": {
              "type": "string",
              "description": "Privacy Algorithm (optional)"
            },
            "privacyPassword": {
              "type": "string",
              "description": "Privacy Password (required if privacyAlgorithm is provided)"
            },
            "engineId": {
              "type": "string",
              "description": "SNMP Engine ID (optional)"
            }
          },
          "required": ["user"]
        },
        "sshv1": {
          "type": "object",
          "description": "SSHv1 credentials.",
          "properties": {
            "user": {
              "type": "string",
              "description": "Username"
            },
            "password": {
              "type": "string",
              "description": "Password (optional if enablePassword is provided)"
            },
            "enableUser": {
              "type": "string",
              "description": "Enable Username (optional)"
            },
            "enablePassword": {
              "type": "string",
              "description": "Enable Password (required if password is not provided)"
            },
            "port": {
              "type": "integer",
              "description": "Port (optional, default = 22)"
            }
          },
          "required": ["user"]
        },
        "sshv2": {
          "type": "object",
          "description": "SSHv2 credentials.",
          "properties": {
            "user": {
              "type": "string",
              "description": "Username"
            },
            "password": {
              "type": "string",
              "description": "Password (optional if enablePassword is provided)"
            },
            "enableUser": {
              "type": "string",
              "description": "Enable Username (optional)"
            },
            "enablePassword": {
              "type": "string",
              "description": "Enable Password (required if password is not provided)"
            },
            "port": {
              "type": "integer",
              "description": "Port (optional, default = 22)"
            }
          },
          "required": ["user"]
        },
        "telnet": {
          "type": "object",
          "description": "Telnet credentials.",
          "properties": {
            "user": {
              "type": "string",
              "description": "Username"
            },
            "password": {
              "type": "string",
              "description": "Password (optional if enablePassword is provided)"
            },
            "enableUser": {
              "type": "string",
              "description": "Enable Username (optional)"
            },
            "enablePassword": {
              "type": "string",
              "description": "Enable Password (required if password is not provided)"
            },
            "port": {
              "type": "integer",
              "description": "Port (optional, default = 23)"
            }
          },
          "required": ["user"]
        },
        "http": {
          "type": "object",
          "description": "HTTP credentials.",
          "properties": {
            "user": {
              "type": "string",
              "description": "Username (optional)"
            },
            "password": {
              "type": "string",
              "description": "Password (optional)"
            },
            "port": {
              "type": "integer",
              "description": "Port (optional, default = 80)"
            }
          }
        },
        "https": {
          "type": "object",
          "description": "HTTPS credentials.",
          "properties": {
            "user": {
              "type": "string",
              "description": "Username (optional)"
            },
            "password": {
              "type": "string",
              "description": "Password (optional)"
            },
            "port": {
              "type": "integer",
              "description": "Port (optional, default = 443)"
            }
          }
        }
      },
      "additionalProperties": false
    }
  },
  "required": ["targetIp", "credentials"],
  "additionalProperties": false
}

Revision History

Revision Publish Date Comments
1.0
05-Dec-2025
Initial Release

Was this Document Helpful?

FeedbackFeedback

Contact Cisco