Device Credentials

Location in GUI: Design » Network Settings » Device Credentials

Diagram

Classes

network_settings (catalyst_center)

Name	Type	Constraint	Mandatory	Default Value
device_credentials	Class	`[device_credentials]`	No

device_credentials (catalyst_center.network_settings)

Name	Type	Constraint	Mandatory
cli_credentials	List	`[cli_credentials]`	No
https_read_credentials	List	`[https_read_credentials]`	No
https_write_credentials	List	`[https_write_credentials]`	No
snmpv3_credentials	List	`[snmpv3_credentials]`	No
snmpv2_read_credentials	List	`[snmpv2_read_credentials]`	No
snmpv2_write_credentials	List	`[snmpv2_write_credentials]`	No

cli_credentials (catalyst_center.network_settings.device_credentials)

Name	Type	Mandatory
name	String	Yes
username	String	Yes
password	String	Yes
enable	String	No

https_read_credentials (catalyst_center.network_settings.device_credentials)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
username	String		Yes
password	String		Yes
port	Integer	min: `1`, max: `65535`	No	`443`

https_write_credentials (catalyst_center.network_settings.device_credentials)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
username	String		Yes
password	String		Yes
port	Integer	min: `1`, max: `65535`	No	`443`

snmpv3_credentials (catalyst_center.network_settings.device_credentials)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
auth_type	Choice	`SHA`, `MD5`	No	`SHA`
privacy_type	Choice	`AES256`, `AES192`, `AES128`	No	`AES128`
snmp_mode	Choice	`AUTHPRIV`, `AUTHNOPRIV`, `NOAUTHNOPRIV`	Yes
username	String		Yes
auth_password	String		Yes
privacy_password	String		Yes

snmpv2_read_credentials (catalyst_center.network_settings.device_credentials)

Name	Type	Mandatory
name	String	Yes
description	String	No
read_community	String	Yes

snmpv2_write_credentials (catalyst_center.network_settings.device_credentials)

Name	Type	Mandatory
name	String	Yes
description	String	No
write_community	String	Yes

Examples

catalyst_center:
  network_settings:
    device_credentials:
      cli_credentials:
        - name: tf-admin1
          username: cisco1
          password: Cisco123!
          enable: cisco
      snmpv2_read_credentials:
        - name: snmp_read
          description: snmp_read
          read_community: Cisco123!
      snmpv2_write_credentials:
        - name: snmp_write
          description: snmp_write
          write_community: Cisco123!
      snmpv3_credentials:
        - name: snmpv3
          auth_type: SHA
          privacy_type: AES128
          snmp_mode: AUTHPRIV
          username: cisco
          auth_password: Cisco123!
          privacy_password: Cisco123!
      https_write_credentials:
        - name: https_write
          username: write_admin
          password: Cisco123!
          port: 443
      https_read_credentials:
        - name: https_read
          username: read_admin
          password: Cisco123!
          port: 443

Example of Assigning Device Credentials to Site:

catalyst_center:
  sites:
    areas:
      - name: Krakow
        parent_name: Global/Poland
        cli_credentials: tf-admin1
        snmpv3_credentials: snmpv3
        https_read_credentials: https_read
        https_write_credentials: https_write