netbox_ipam¶
Constants¶
-
plugins.module_utils.netbox_ipam.NB_AGGREGATES= 'aggregates'¶ str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.
-
plugins.module_utils.netbox_ipam.NB_IP_ADDRESSES= 'ip_addresses'¶ str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.
-
plugins.module_utils.netbox_ipam.NB_PREFIXES= 'prefixes'¶ str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.
-
plugins.module_utils.netbox_ipam.NB_IPAM_ROLES= 'roles'¶ str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.
-
plugins.module_utils.netbox_ipam.NB_RIRS= 'rirs'¶ str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.
-
plugins.module_utils.netbox_ipam.NB_VLANS= 'vlans'¶ str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.
-
plugins.module_utils.netbox_ipam.NB_VLAN_GROUPS= 'vlan_groups'¶ str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.
-
plugins.module_utils.netbox_ipam.NB_VRFS= 'vrfs'¶ str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.
-
plugins.module_utils.netbox_ipam.NB_SERVICES= 'services'¶ str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.
Classes¶
-
class
plugins.module_utils.netbox_ipam.NetboxIpamModule(*args: Any, **kwargs: Any)¶ -
__init__(module, endpoint)¶ Initialize self. See help(type(self)) for accurate signature.
-
_ensure_ip_in_prefix_present_on_netif(nb_app, nb_endpoint, data, endpoint_name)¶
-
_get_new_available_ip_address(nb_app, data, endpoint_name)¶
-
_get_new_available_prefix(data, endpoint_name)¶
-
_handle_state_new_present(nb_app, nb_endpoint, endpoint_name, name, data)¶
-
run()¶ This function should have all necessary code for endpoints within the application to create/update/delete the endpoint objects Supported endpoints: - aggregates - ipam_roles - ip_addresses - prefixes - rirs - route_targets - vlans - vlan_groups - vrfs
-