ifmap Package

ifmap Package

ifmap-python client is an implementation of the TCG IF-MAP 2.0 protocol as a client library.

exception vnc_cfg_api_server.ifmap.Error(msg)

Bases: exceptions.Exception

Base class for exception handling

client Module

class vnc_cfg_api_server.ifmap.client.client(url, user=None, password=None, namespaces={}, ssl_opts=None)

IF-MAP client

id Module

class vnc_cfg_api_server.ifmap.id.AccessRequest(name, administrative_domain=None)

Bases: vnc_cfg_api_server.ifmap.id.ifmapIDFactory

XML Factory for an Access Request IF-MAP Identifier

class vnc_cfg_api_server.ifmap.id.CustomIdentity(name, ns_prefix='', namespace='', attributes=None)

Bases: vnc_cfg_api_server.ifmap.id.ifmapIDFactory

XML Factory for an Custom IF-MAP Identifier with namespace prefix or URL

class vnc_cfg_api_server.ifmap.id.Device(name, aik_name=None)

Bases: vnc_cfg_api_server.ifmap.id.ifmapIDFactory

XML Factory for a Device IF-MAP Identifier

class vnc_cfg_api_server.ifmap.id.IPAddress(ip_address, type=None, administrative_domain=None)

Bases: vnc_cfg_api_server.ifmap.id.ifmapIDFactory

XML Factory for an IP Address IF-MAP Identifier

class vnc_cfg_api_server.ifmap.id.Identity(name, type=None, other_type=None, administrative_domain=None)

Bases: vnc_cfg_api_server.ifmap.id.ifmapIDFactory

XML Factory for an IF-MAP Identifier

class vnc_cfg_api_server.ifmap.id.MACAddress(mac_address, administrative_domain=None)

Bases: vnc_cfg_api_server.ifmap.id.ifmapIDFactory

XML Factory for a MAC Address IF-MAP Identifier

metadata Module

class vnc_cfg_api_server.ifmap.metadata.Metadata(name, value=None, attributes=None, ns_prefix=None, ns_uri=None, elements='')

Bases: vnc_cfg_api_server.ifmap.metadata.MetadataBase

Metadata factory

class vnc_cfg_api_server.ifmap.metadata.MetadataBase

foundation class for metadata factory

operations Module

class vnc_cfg_api_server.ifmap.operations.OperationBase

foundation class for operation factory

class vnc_cfg_api_server.ifmap.operations.SubscribeUpdateOperation(name, identifier, search_parameters={})

Bases: vnc_cfg_api_server.ifmap.operations.OperationBase

SubscribeUpdate factory name identifier (single, or linked with link_ids()) search_parameters - dictionary eg. {‘max_depth’:‘3’, ‘max_size’:‘10000’}

result_filter => string, #Optional. Rules for extracting specific data from the results match_links => string, #Optional. Filter to match links to be followed, unmatched links will not be followed in the search process max_depth => number, #Optional. Maximum distance of any included identifiers. Start depth is equal to 0 max_size => number, #Optional. Maximum size in bytes of the results terminal_identifier_type => string, #Optional. Terminal identifier type of the search request

request Module

class vnc_cfg_api_server.ifmap.request.RequestBase

foundation class for request factory

class vnc_cfg_api_server.ifmap.request.SearchRequest(session_id, identifier, namespaces=None, validation=None, search_parameters={})

Bases: vnc_cfg_api_server.ifmap.request.RequestBase

Search request factory session_id identifier (single, or linked with link_ids()) namespaces validation “None”|”BaseOnly”|”MetadataOnly”|”All” search_parameters - dictionary eg. {‘max_depth’:‘3’, ‘max_size’:‘10000’}

result_filter => string, #Optional. Rules for extracting specific data from the results match_links => string, #Optional. Filter to match links to be followed, unmatched links will not be followed in the search process max_depth => number, #Optional. Maximum distance of any included identifiers. Start depth is equal to 0 max_size => number, #Optional. Maximum size in bytes of the results terminal_identifier_type => string, #Optional. Terminal identifier type of the search request

class vnc_cfg_api_server.ifmap.request.SubscribeRequest(session_id, validation=None, namespaces=None, operations=None)

Bases: vnc_cfg_api_server.ifmap.request.RequestBase

Subscribe request factory

response Module

class vnc_cfg_api_server.ifmap.response.Response(result)

Base class to handle and parse IF-MAP responses

element()

Returns the raw Element object

class vnc_cfg_api_server.ifmap.response.newSessionResult(result)

Bases: vnc_cfg_api_server.ifmap.response.Response

newSessionResult

util Module

vnc_cfg_api_server.ifmap.util.attr(attributes)

attr creates an XML string for any attribute that has a value attr({‘session-id’: ‘2345’, ‘validation’:’metadata’})

vnc_cfg_api_server.ifmap.util.link_ids(id1, id2)

Takes two id arguments. Returns XML for id1 or links id1 and id2 together