api.settings

Cisco vManage Settings API Methods.

Module Contents

class api.settings.Settings(session, host, port=443)[source]

Bases: object

vManage Settings API

Responsible for DELETE, GET, POST, PUT methods against vManage Settings.

get_vmanage_org(self)[source]

Get vManage organization

Args:

Returns

The vManage organization.

Return type

org (str)

set_vmanage_org(self, org)[source]

Set vManage organization

Parameters

org (str) – The organization name to set.

Returns

The result of the POST operation

Return type

result (dict)

get_vmanage_vbond(self)[source]

Get vBond

Args:

Returns

The result of the GET operation.

Return type

result (dict)

set_vmanage_vbond(self, vbond, vbond_port='12346')[source]

Set vBond

Parameters
  • vbond (str) – The vBond IP address.

  • vbond_port (str) – The vBond port.

Returns

The result of the POST operation.

Return type

result (dict)

get_vmanage_ca_type(self)[source]

Get vManage CA type

Args:

Returns

The CA type.

Return type

certificateSigning (str)

set_vmanage_ca_type(self, ca_type)[source]

Set vManage CA type

Parameters

ca_type (str) – The CA type.

Returns

The result of the POST operation.

Return type

result (dict)

set_vmanage_root_cert(self, cert, timeout=20)[source]

Set vManage root certiticate

Parameters
  • cert (str) – The root certiticate.

  • timeout (int) – Timeout in seconds.

Returns:

get_vmanage_banner(self)[source]

Get vManage Banner

Args:

Returns

The banner for vmanage.

Return type

bannerDetail (str)