Networking, Lens API, password
Description
A password instance represents a credential used for administrative or monitoring access to network devices. Each instance includes a string password value, a type, and an optional user/login account name. A password record does not in itself imply any specific capabilities conferred by the password. These are naturally determined by the device itself. Devices may have any number of passwords of any type.
(In a future release:)
Passwords also belong to Lens namespaces, and are authorized for read and write access by the parent namespace.NOTE: Device passwords may be maintained by external applications which apply site policies (such as default values based on deployment role and activity at layers 2 or 3). The policies may be driven by other software and data including, for example, deviceclass memberships and class_attribute values. However, device_password instances intend to reflect the expected configurations per device so that each one is an assertion of fact in and of itself.
Parameter prefix: pwd
Relationships
Show all relationships | Outline view
device
Related type: device
Description: The device instance to which a password applies.
Dressing parameter: pwd_device
Cardinality: exactly one (scalar)
Relationship Attribute: password.device_id
Availability restricted to: Always available when password instance is available.
Planned for a future release
namespace
Related type: namespace
Description: The name of namespace in which the instance is defined and by which it is authorized.
Dressing parameter: pwd_namespace
Relationship Attribute: This topic/item has not yet been finalized.
Availability restricted to: Always available when device_password instance is available.
Attributes
Identity attribute
| Attribute | Data type | Description | Query Parameter data type |
|---|---|---|---|
| password_id | Instance identifier | Unique device password identifier | Instance identifier |
Essential attributes
| Attribute | Data type | Description | Query parameter data type |
|---|---|---|---|
| password_type | Text | A recognized password type distinguishing among access paths available for devices | String |
| password | Text | Authentication token | String |
| login_name | Text | A (possibly void) username associated with the credential | String |
| device_name* | Text | device_name attribute of device for which the password applies | String |
| device_id* | Integer | id attribute of device for which the password applies | Number |
| device_ip* | IP | ip attribute of device for which the password applies | IP |
| current | Boolean | True when an instance describes the present configuration | Boolean (1 or 0) |
| start_date | Timestamp | Time when device configuration became known to Lens | Date |
| end_date | Timestamp | Time when device configuration is known to have ceased, or 1/1/2037 for current devices | Date |
An asterisk ( * ) denotes a "migrated" attribute, provided for convenience
Planned for a future release
Auditing attributes
These attributes describe the modification history for the instance
Availability restricted to: This topic/item has not yet been finalized.
Dressing parameter: pwd_auditing
| Attribute | Data type | Description | Query Parameter Data Type |
|---|---|---|---|
| created_by | Text | Name of user that created the Device record | String |
| created_date | Timestamp | Time when record was created | Date |
| modified_by | Text | Name of user who last modified Device record | String |
| timestamp | Timestamp | Time of last modification | Date |