Nautobot Plugin Nornir Credentials¶
nautobot_plugin_nornir.plugins.credentials
¶
Init file for credentials.
env_vars
¶
Credentials class for environment variables passwords.
CredentialsEnvVars
¶
Bases: MixinNautobotORMCredentials
Credentials Class designed to work with Nautobot ORM.
This class is the default class that will return the same login and password for all devices based on the values of the environment variables
Source code in nautobot_plugin_nornir/plugins/credentials/env_vars.py
__init__(params=None)
¶
Initialize Credentials Class designed to work with Nautobot ORM.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params |
[dict]
|
Credentials Parameters |
None
|
Source code in nautobot_plugin_nornir/plugins/credentials/env_vars.py
nautobot_orm
¶
Credentials class designed to work with Nautobot ORM.
MixinNautobotORMCredentials
¶
Bases: NautobotORMCredentials
Abstract Credentials Class mixin, to provide base get_device_creds functionality.
Source code in nautobot_plugin_nornir/plugins/credentials/nautobot_orm.py
get_device_creds(device)
¶
Return the credentials for a given device.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
device |
dcim.models.Device
|
Nautobot device object |
required |
Return
username (string): password (string): secret (string):
Source code in nautobot_plugin_nornir/plugins/credentials/nautobot_orm.py
NautobotORMCredentials
¶
Abstract Credentials Class designed to work with Nautobot ORM.
Source code in nautobot_plugin_nornir/plugins/credentials/nautobot_orm.py
get_device_creds(device)
¶
Return the credentials for a given device.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
device |
dcim.models.Device
|
Nautobot device object |
required |
Return
username (string): password (string): secret (string):
Source code in nautobot_plugin_nornir/plugins/credentials/nautobot_orm.py
get_group_creds(group_name)
¶
Return the credentials for a given group.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
group_name |
string
|
Name of the group |
required |
Return
string: username string: password string: secret
Source code in nautobot_plugin_nornir/plugins/credentials/nautobot_orm.py
nautobot_secrets
¶
Credentials class designed to work with Nautobot Secrets Functionality.
CredentialsNautobotSecrets
¶
Bases: MixinNautobotORMCredentials
Credentials Class designed to work with Nautobot Secrets Functionality.
Source code in nautobot_plugin_nornir/plugins/credentials/nautobot_secrets.py
get_device_creds(device)
¶
Return the credentials for a given device.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
device |
dcim.models.Device
|
Nautobot device object |
required |
Return
username (string): password (string): secret (string):
Source code in nautobot_plugin_nornir/plugins/credentials/nautobot_secrets.py
settings_vars
¶
Credentials class for setting credentials.
CredentialsSettingsVars
¶
Bases: MixinNautobotORMCredentials
Credentials Class designed to work with Nautobot ORM that comes from settings.
This class will return the same login and password for all devices based on the values within your settings.
Source code in nautobot_plugin_nornir/plugins/credentials/settings_vars.py
__init__(params=None)
¶
Initialize Credentials Class designed to work with Nautobot ORM.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params |
[dict]
|
Credentials Parameters |
None
|