SSH Device Placement

class SSHDevicePlacement(api)

Bases: _ClientWorkBase

create(name, devices_folder, share_mode='SpecifiedFolderAndSubFolders', attributes=None, get_if_already_exists=True)
Parameters

  • name (str) – The name of the client work

  • devices_folder (Union[config.Object, str]) – Config Object or Distinguished Name (DN) of the folder to place newly discovered ssh devices.

  • share_mode (str) – Mode to de-duplicate newly discovered devices: * “WholeTree” : Search the entire policy tree * “SpecifiedFolderOnly” : Search the devices folder * “SpecifiedFolderAndSubFolders” : Search the devices folder and all sub-folders * “None” : Create a duplicate device

  • attributes (dict) – Additional attributes to apply to the object.

  • get_if_already_exists (bool) – If the objects already exists, just return it as is.

Returns

Config Object of the client work.

delete(work)

Deletes the client work.

Parameters

work (Union[config.Object, str]) – Config Object or name of the client work.

disable(work)

Disables the client work.

Parameters

work (Union[config.Object, str]) – Config Object or name of the client work.

enable(work)

Enables the client work.

Parameters

work (Union[config.Object, str]) – Config Object or name of the client work.

get(name, raise_error_if_not_exists=True)
Parameters

  • name (str) – The name of the client work.

  • raise_error_if_not_exists (bool) – Raise an exception if the client work does not exist.

Returns

Config Object of the client work.

list()

Lists all client work.

Returns

List of Config Object of all client work.