mirror of
https://github.com/checktheroads/hyperglass
synced 2024-05-11 05:55:08 +00:00
60 lines
1.7 KiB
Python
60 lines
1.7 KiB
Python
"""Validate SSH proxy configuration variables."""
|
|
|
|
# Third Party Imports
|
|
from pydantic import StrictInt
|
|
from pydantic import StrictStr
|
|
from pydantic import validator
|
|
|
|
# Project Imports
|
|
from hyperglass.configuration.models._utils import HyperglassModel
|
|
from hyperglass.configuration.models._utils import clean_name
|
|
from hyperglass.configuration.models.credentials import Credential
|
|
from hyperglass.exceptions import UnsupportedDevice
|
|
|
|
|
|
class Proxy(HyperglassModel):
|
|
"""Validation model for per-proxy config in devices.yaml."""
|
|
|
|
name: StrictStr
|
|
address: StrictStr
|
|
port: StrictInt = 22
|
|
credential: Credential
|
|
nos: StrictStr = "linux_ssh"
|
|
|
|
@validator("nos")
|
|
def supported_nos(cls, value):
|
|
"""Verify NOS is supported by hyperglass.
|
|
|
|
Raises:
|
|
UnsupportedDevice: Raised if NOS is not supported.
|
|
|
|
Returns:
|
|
{str} -- Valid NOS name
|
|
"""
|
|
if not value == "linux_ssh":
|
|
raise UnsupportedDevice(f'"{value}" device type is not supported.')
|
|
return value
|
|
|
|
|
|
class Proxies(HyperglassModel):
|
|
"""Validation model for SSH proxy configuration."""
|
|
|
|
@classmethod
|
|
def import_params(cls, input_params):
|
|
"""Import loaded YAML, initialize per-proxy definitions.
|
|
|
|
Remove unsupported characters from proxy names, dynamically
|
|
set attributes for the proxies class.
|
|
|
|
Arguments:
|
|
input_params {dict} -- Unvalidated proxy definitions
|
|
|
|
Returns:
|
|
{object} -- Validated proxies object
|
|
"""
|
|
obj = Proxies()
|
|
for (devname, params) in input_params.items():
|
|
dev = clean_name(devname)
|
|
setattr(Proxies, dev, Proxy(**params))
|
|
return obj
|