Introduction

Utility library for retrieving entity related data from ODL.

Keywords

Get

Arguments

url params
= None
** kwargs

Documentation

Sends a GET request.

:param url: URL for the new :class:Request object. :param params: (optional) Dictionary, list of tuples or bytes to send in the query string for the :class:Request. :param \*\*kwargs: Optional arguments that request takes. :return: :class:Response <Response> object :rtype: requests.Response

Arguments

restconf_url

Arguments

restconf_url

Documentation

Get the entity information from the datastore for Silicon or earlier versions. :param restconf_url: RESTCONF URL up to the RESTCONF root

Arguments

restconf_url e_type e_name

Documentation

Calls the get-entity rpc on the controller and returns the result in a dictionary that contains the parsed response in two keys: "candidates" and "owner"

Arguments

restconf_url e_type e_name

Documentation

Get the entity owner & candidates for the given entity type and entity name from the datastore for Silicon or earlier versions :param restconf_url: RESTCONF URL up to the RESTCONF root :param e_type: entity type :param e_name: entity name :return: entity owner & candidates

Arguments

e_type e_name

Documentation

Get the effective entity name for the given entity type. If the entity type is not for odl-general-entity, entity name should be the full instance identifier. :param e_type: entity type :param e_name: entity name :return: updated entity name

Arguments

restconf_url e_type e_name

Arguments

restconf_url e_type e_name

Documentation

Get the entity owner for the given entity type and entity name from the datastore for Silicon or earlier versions :param restconf_url: RESTCONF URL up to the RESTCONF root :param e_type: entity type :param e_name: entity name :return: entity owner

Arguments

restconf_url e_type

Documentation

Get the entity information for the given entity type from the datastore for Silicon or earlier versions. :param restconf_url: RESTCONF URL up to the RESTCONF root :param e_type: entity type :return: entity-type

Arguments

msg * args ** kwargs

Documentation

Log a message with severity 'INFO' on the root logger. If the logger has no handlers, call basicConfig() to add a console handler with a pre-defined format.

Arguments

args

Arguments

url data
= None
json
= None
** kwargs

Documentation

Sends a POST request.

:param url: URL for the new :class:Request object. :param data: (optional) Dictionary, list of tuples, bytes, or file-like object to send in the body of the :class:Request. :param json: (optional) A JSON serializable Python object to send in the body of the :class:Request. :param \*\*kwargs: Optional arguments that request takes. :return: :class:Response <Response> object :rtype: requests.Response

ClusterEntities

image/svg+xml