Skip to content

Device Credentials

Location in GUI: Design » Network Settings » Device Credentials

Diagram
NameTypeConstraintMandatoryDefault Value
device_credentialsClass[device_credentials]No

device_credentials (catalyst_center.network_settings)

Section titled “device_credentials (catalyst_center.network_settings)”
NameTypeConstraintMandatoryDefault Value
cli_credentialsList[cli_credentials]No
https_read_credentialsList[https_read_credentials]No
https_write_credentialsList[https_write_credentials]No
snmpv3_credentialsList[snmpv3_credentials]No
snmpv2_read_credentialsList[snmpv2_read_credentials]No
snmpv2_write_credentialsList[snmpv2_write_credentials]No

cli_credentials (catalyst_center.network_settings.device_credentials)

Section titled “cli_credentials (catalyst_center.network_settings.device_credentials)”
NameTypeConstraintMandatoryDefault Value
nameStringYes
usernameStringYes
passwordStringYes
enableStringNo

https_read_credentials (catalyst_center.network_settings.device_credentials)

Section titled “https_read_credentials (catalyst_center.network_settings.device_credentials)”
NameTypeConstraintMandatoryDefault Value
nameStringYes
usernameStringYes
passwordStringYes
portIntegermin: 1, max: 65535No443

https_write_credentials (catalyst_center.network_settings.device_credentials)

Section titled “https_write_credentials (catalyst_center.network_settings.device_credentials)”
NameTypeConstraintMandatoryDefault Value
nameStringYes
usernameStringYes
passwordStringYes
portIntegermin: 1, max: 65535No443

snmpv3_credentials (catalyst_center.network_settings.device_credentials)

Section titled “snmpv3_credentials (catalyst_center.network_settings.device_credentials)”
NameTypeConstraintMandatoryDefault Value
nameStringYes
auth_typeChoiceSHA, MD5NoSHA
privacy_typeChoiceAES256, AES192, AES128NoAES128
snmp_modeChoiceAUTHPRIV, AUTHNOPRIV, NOAUTHNOPRIVYes
usernameStringYes
auth_passwordStringYes
privacy_passwordStringYes

snmpv2_read_credentials (catalyst_center.network_settings.device_credentials)

Section titled “snmpv2_read_credentials (catalyst_center.network_settings.device_credentials)”
NameTypeConstraintMandatoryDefault Value
nameStringYes
descriptionStringNo
read_communityStringYes

snmpv2_write_credentials (catalyst_center.network_settings.device_credentials)

Section titled “snmpv2_write_credentials (catalyst_center.network_settings.device_credentials)”
NameTypeConstraintMandatoryDefault Value
nameStringYes
descriptionStringNo
write_communityStringYes

Example 1: Basic device credentials configuration with CLI access using standard Cisco credentials and enable password for network device management:

catalyst_center:
network_settings:
device_credentials:
cli_credentials:
- name: BASIC_CLI_ADMIN
username: admin
password: CiscoAdmin123!
enable: CiscoEnable123!

Example 2: SNMP monitoring setup with both read and write community strings for network device monitoring and configuration management across European sites:

catalyst_center:
network_settings:
device_credentials:
cli_credentials:
- name: EUROPE_CLI_ADMIN
username: netadmin
password: EuropeAdmin456!
enable: EuropeEnable456!
snmpv2_read_credentials:
- name: EUROPE_SNMP_READ
description: "European sites SNMP read access"
read_community: EuropeReadComm789
snmpv2_write_credentials:
- name: EUROPE_SNMP_WRITE
description: "European sites SNMP write access"
write_community: EuropeWriteComm789

Example 3: Comprehensive device credentials deployment with all supported authentication methods including CLI, SNMPv2, SNMPv3 with multiple security modes, and HTTPS credentials for REST API access across global enterprise infrastructure:

catalyst_center:
network_settings:
device_credentials:
cli_credentials:
- name: GLOBAL_CLI_ADMIN
username: globaladmin
password: GlobalAdmin2024!
enable: GlobalEnable2024!
- name: BRANCH_CLI_READONLY
username: branchread
password: BranchRead2024!
snmpv2_read_credentials:
- name: GLOBAL_SNMP_READ
description: "Global monitoring read access"
read_community: GlobalMonitorRead
- name: BRANCH_SNMP_READ
description: "Branch office monitoring"
read_community: BranchMonitorRead
snmpv2_write_credentials:
- name: GLOBAL_SNMP_WRITE
description: "Global configuration write access"
write_community: GlobalConfigWrite
snmpv3_credentials:
- name: SECURE_SNMPV3_AUTHPRIV
auth_type: SHA
privacy_type: AES256
snmp_mode: AUTHPRIV
username: secureuser
auth_password: SecureAuth2024!
privacy_password: SecurePriv2024!
- name: STANDARD_SNMPV3_AUTHNOPRIV
auth_type: MD5
privacy_type: AES128
snmp_mode: AUTHNOPRIV
username: standarduser
auth_password: StandardAuth2024!
privacy_password: StandardPriv2024!
- name: BASIC_SNMPV3_NOAUTH
snmp_mode: NOAUTHNOPRIV
username: basicuser
auth_password: BasicAuth2024!
privacy_password: BasicPriv2024!
https_read_credentials:
- name: API_READ_ACCESS
username: apiread
password: ApiRead2024!
port: 443
- name: MONITORING_API_ACCESS
username: monitor
password: Monitor2024!
port: 8443
https_write_credentials:
- name: API_WRITE_ACCESS
username: apiwrite
password: ApiWrite2024!
port: 443
- name: CONFIG_API_ACCESS
username: configapi
password: ConfigApi2024!
port: 9443

Example 4: Site assignment configuration demonstrating how to apply different credential sets to various site types and geographic locations:

catalyst_center:
sites:
areas:
- name: Corporate Headquarters
parent_name: Global/Americas/USA/California
cli_credentials: GLOBAL_CLI_ADMIN
snmpv3_credentials: SECURE_SNMPV3_AUTHPRIV
https_read_credentials: API_READ_ACCESS
https_write_credentials: API_WRITE_ACCESS
- name: European Operations
parent_name: Global/Europe/Germany
cli_credentials: EUROPE_CLI_ADMIN
snmpv2_read_credentials: EUROPE_SNMP_READ
snmpv2_write_credentials: EUROPE_SNMP_WRITE
https_read_credentials: MONITORING_API_ACCESS
buildings:
- name: Branch Office
parent_name: Global/Americas/USA/Texas/Austin
address: 110 Inner Campus Dr., Austin, TX 78712, USA
cli_credentials: BRANCH_CLI_READONLY
snmpv2_read_credentials: BRANCH_SNMP_READ
snmpv3_credentials: STANDARD_SNMPV3_AUTHNOPRIV
- name: Regional Center
parent_name: Global/Americas/USA/Texas/College Station
address: 400 Bizzell St, College Station, TX 77840, USA
cli_credentials: GLOBAL_CLI_ADMIN
snmpv3_credentials: SECURE_SNMPV3_AUTHPRIV
https_read_credentials: API_READ_ACCESS
https_write_credentials: CONFIG_API_ACCESS