AXL Client

The AXLClient wraps all 1,068 AXL WSDL operations for Cisco UCM configuration management. It supports both Thick AXL (SOAP-based CRUD) and Thin AXL (direct SQL queries against the UCM Informix database).

Every get_*, add_*, update_*, remove_*, list_*, apply_*, reset_*, and restart_* operation in the AXL 15.0 schema has a corresponding snake_case method.

Quick Example

from axltoolkit import AXLClient

client = AXLClient(
    username="admin",
    password="secret",
    server_ip="ucm-pub.example.com",
    version="15.0",
    tls_verify=True,
)

# CRUD operations
phone = client.get_phone(name="SEP001122334455")
client.update_phone(name="SEP001122334455", description="Lab Phone")

# SQL query
result = client.sql_query("SELECT name FROM device WHERE name LIKE 'SEP%'")

Class Reference

axltoolkit.axl.AXLClient

AXLClient(username: str, password: str, server_ip: str, *, version: str = '15.0', tls_verify: Union[bool, str] = True, timeout: int = 30, max_retries: int = 3)

Bases: BaseClient

Client for the Cisco UCM AXL SOAP API.

Wraps both Thick AXL (SOAP-based CRUD for configuration objects such as phones, users, route partitions, etc.) and Thin AXL (direct SQL queries and updates against the UCM Informix database).

Parameters:

Name	Type	Description	Default
username	str	AXL/CCMAdministrator user name.	required
password	str	Password.	required
server_ip	str	UCM publisher IP address or FQDN.	required
version	str	AXL schema version. Must be one of "10.0", "10.5", "11.0", "11.5", "12.0", "12.5", "14.0", "15.0". Defaults to "15.0.	'15.0'
tls_verify	Union[bool, str]	True to verify the server certificate, False to skip verification, or a path to a custom CA bundle.	True
timeout	int	Request timeout in seconds (default 30).	30
max_retries	int	Retry count for transient failures (default 3).	3

Example::

client = AXLClient("admin", "password", "ucm-pub.example.com", version="15.0")
phone = client.get_phone(name="SEP001122334455")
print(phone['return']['phone']['name'])

version property

version: str

The AXL schema version this client is using.

service property

service

Direct access to the underlying zeep service proxy.

Useful for calling AXL operations that do not yet have a dedicated wrapper method::

result = client.service.addAppUser(appUser={...})

sql_query

sql_query(query: str) -> Dict[str, Any]

Execute a read-only SQL query via Thin AXL.

Parameters:

Name	Type	Description	Default
query	str	A SQL SELECT statement to execute against the UCM Informix database.	required

Returns:

Type	Description
Dict[str, Any]	A dict with keys:
Dict[str, Any]	num_rows (int): Number of rows returned.
Dict[str, Any]	query (str): The original query string.
Dict[str, Any]	rows (list[dict]): List of row dicts (column name → value). Only present when num_rows > 0.

Raises:

Type	Description
AXLSQLError	If the query fails.

.. warning:: This method sends the query string directly to the UCM Informix database with no parameterization or escaping. Never build queries from untrusted input without sanitizing values first. Use :func:_sanitize_sql_value or the higher-level sql_get_* helpers which sanitize automatically.

Example::

result = client.sql_query("SELECT name, description FROM device WHERE name LIKE 'SEP%'")
for row in result.get('rows', []):
    print(row['name'], row['description'])

sql_update

sql_update(query: str) -> Dict[str, Any]

Execute a SQL INSERT, UPDATE, or DELETE via Thin AXL.

Parameters:

Name	Type	Description	Default
query	str	A SQL DML statement.	required

Returns:

Type	Description
Dict[str, Any]	A dict with keys:
Dict[str, Any]	rows_updated (int): Number of rows affected.
Dict[str, Any]	query (str): The original query string.

Raises:

Type	Description
AXLSQLError	If the update fails.

.. warning:: This method sends the query string directly to the UCM Informix database with no parameterization or escaping. Never build queries from untrusted input without sanitizing values first. Use :func:_sanitize_sql_value or the higher-level sql_* helpers which sanitize automatically.

Example::

result = client.sql_update(
    "UPDATE device SET description='Test' WHERE name='SEP001122334455'"
)
print(f"Updated {result['rows_updated']} rows")

get_call_manager_group

get_call_manager_group(name: str) -> Dict[str, Any]

Retrieve a Call Manager Group by name.

Parameters:

Name	Type	Description	Default
name	str	The name of the Call Manager Group.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the group does not exist.
AXLError	On other AXL faults.

add_call_manager_group

add_call_manager_group(name: str, members: Sequence[str]) -> Dict[str, Any]

Add a new Call Manager Group.

Parameters:

Name	Type	Description	Default
name	str	Name for the new group.	required
members	Sequence[str]	Ordered list of Call Manager (process node) names. The first entry gets priority 1, second gets priority 2, etc.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict (contains the UUID of the created group).

Raises:

Type	Description
AXLDuplicateError	If a group with this name already exists.
AXLError	On other AXL faults.

Example::

client.add_call_manager_group("CMGroup-1", ["cm1pub", "cm1sub1"])

update_call_manager_group_members

update_call_manager_group_members(name: str, members: Sequence[str]) -> Dict[str, Any]

Update the member list of an existing Call Manager Group.

Parameters:

Name	Type	Description	Default
name	str	Name of the group to update.	required
members	Sequence[str]	New ordered list of Call Manager names.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the group does not exist.
AXLError	On other AXL faults.

remove_call_manager_group

remove_call_manager_group(name: str) -> Dict[str, Any]

Remove a Call Manager Group by name.

Parameters:

Name	Type	Description	Default
name	str	The name of the group to remove.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the group does not exist.
AXLError	On other AXL faults.

get_user

get_user(userid: str) -> Dict[str, Any]

Retrieve an end user by user ID.

Parameters:

Name	Type	Description	Default
userid	str	The UCM user ID (login name).	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict. Access user fields via
Dict[str, Any]	result['return']['user'].

Raises:

Type	Description
AXLNotFoundError	If the user does not exist.
AXLError	On other AXL faults.

Example::

result = client.get_user("jsmith")
user = result['return']['user']
print(f"{user['firstName']} {user['lastName']}")

list_users

list_users(returned_tags: Optional[Dict[str, str]] = None, **search_criteria) -> Dict[str, Dict[str, Any]]

List end users matching the given search criteria.

Parameters:

Name	Type	Description	Default
returned_tags	Optional[Dict[str, str]]	Dict of tag names to include in the response. Defaults to firstName, lastName, userid.	None
**search_criteria		One or more of firstName, lastName, userid, department. Values may contain % wildcards. If no criteria are given, all users are returned.	{}

Returns:

Type	Description
Dict[str, Dict[str, Any]]	A dict keyed by userid, where each value is a dict with the
Dict[str, Dict[str, Any]]	requested tag values plus uuid.

Raises:

Type	Description
AXLError	On AXL faults.

Example::

users = client.list_users(lastName="Smith%")
for uid, data in users.items():
    print(uid, data['firstName'], data['lastName'])

update_user

update_user(**user_data: Unpack[UpdateUser]) -> Dict[str, Any]

Update an existing end user.

Parameters:

Name	Type	Description	Default
**user_data	Unpack[UpdateUser]	Keyword arguments corresponding to the AXL updateUser operation fields. Must include at least userid or uuid to identify the user.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the user does not exist.
AXLError	On other AXL faults.

Example::

client.update_user(userid="jsmith", firstName="Jonathan")

get_registration_dynamic

get_registration_dynamic(device: str) -> Dict[str, Any]

Retrieve dynamic registration data for a specific device.

Parameters:

Name	Type	Description	Default
device	str	The device name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the device is not found.
AXLError	On other AXL faults.

list_registration_dynamic

list_registration_dynamic(**search_criteria) -> Dict[str, Dict[str, Any]]

List dynamic registration records matching search criteria.

Parameters:

Name	Type	Description	Default
**search_criteria		One or more of device, lastKnownIpAddress, lastKnownUcm, lastKnownConfigVersion, locationDetails, endpointConnection, portOrSsid, lastSeen. Values may contain % wildcards. If none given, returns all registrations.	{}

Returns:

Type	Description
Dict[str, Dict[str, Any]]	A dict keyed by device name, each value containing
Dict[str, Dict[str, Any]]	registration details.

Raises:

Type	Description
AXLError	On AXL faults.

get_line

get_line(pattern: str, route_partition_name: str) -> Dict[str, Any]

Retrieve a directory number (line) by pattern and partition.

Parameters:

Name	Type	Description	Default
pattern	str	The directory number pattern (e.g. "1001").	required
route_partition_name	str	The partition the DN belongs to.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the line does not exist.
AXLError	On other AXL faults.

add_line

add_line(line_data: Line) -> Dict[str, Any]

Add a new directory number (line).

Parameters:

Name	Type	Description	Default
line_data	Line	A dict describing the line. Required keys: pattern, routePartitionName, and usage ("Device" or "Template"). Example:: { "pattern": "1001", "routePartitionName": "Internal-PT", "usage": "Device", "description": "John Smith - 1001", "alertingName": "John Smith", "shareLineAppearanceCssName": "", }	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict (contains the UUID of the created line).

Raises:

Type	Description
AXLDuplicateError	If the line already exists.
AXLError	On other AXL faults.

update_line

update_line(**line_data: Unpack[UpdateLine]) -> Dict[str, Any]

Update an existing directory number (line).

Parameters:

Name	Type	Description	Default
**line_data	Unpack[UpdateLine]	Keyword arguments for the updateLine operation. Must include pattern + routePartitionName or uuid to identify the line.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the line does not exist.
AXLError	On other AXL faults.

Example::

client.update_line(
    pattern="1001",
    routePartitionName="Internal-PT",
    description="Updated Description",
)

remove_line

remove_line(pattern: str, route_partition_name: str) -> Dict[str, Any]

Remove a directory number (line).

Parameters:

Name	Type	Description	Default
pattern	str	The directory number pattern.	required
route_partition_name	str	The partition the DN belongs to.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the line does not exist.
AXLError	On other AXL faults.

get_phone

get_phone(name: str) -> Dict[str, Any]

Retrieve a phone device by name.

Parameters:

Name	Type	Description	Default
name	str	The device name (e.g. "SEP001122334455").	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the phone does not exist.
AXLError	On other AXL faults.

Example::

result = client.get_phone("SEP001122334455")
phone = result['return']['phone']
print(phone['model'], phone['devicePoolName'])

add_phone

add_phone(phone_data: Phone, line_data: Optional[List[Dict[str, Any]]] = None) -> Dict[str, Any]

Add a new phone device.

Parameters:

Name	Type	Description	Default
phone_data	Phone	A dict describing the phone. Required keys include name, product, class ("Phone"), protocol, protocolSide ("User"), devicePoolName, commonPhoneConfigName, and phoneTemplateName. Minimal example:: { "name": "SEP001122334455", "product": "Cisco 8845", "class": "Phone", "protocol": "SIP", "protocolSide": "User", "devicePoolName": "Default", "commonPhoneConfigName": "Standard Common Phone Profile", "phoneTemplateName": "Standard 8845 SIP", "locationName": "Hub_None", "securityProfileName": "Cisco 8845 - Standard SIP Non-Secure Profile", "sipProfileName": "Standard SIP Profile", }	required
line_data	Optional[List[Dict[str, Any]]]	Optional list of line association dicts. Each entry should specify at least dirn (with pattern and routePartitionName) and index:: [ { "index": 1, "dirn": { "pattern": "1001", "routePartitionName": "Internal-PT", }, "display": "John Smith", "displayAscii": "John Smith", } ]	None

Returns:

Type	Description
Dict[str, Any]	The AXL response dict (contains the UUID of the created phone).

Raises:

Type	Description
AXLDuplicateError	If a phone with this name already exists.
AXLValidationError	If required fields are missing.
AXLError	On other AXL faults.

update_phone

update_phone(line_data: Optional[List[Dict[str, Any]]] = None, **phone_data: Unpack[UpdatePhone]) -> Dict[str, Any]

Update an existing phone device.

Parameters:

Name	Type	Description	Default
line_data	Optional[List[Dict[str, Any]]]	Optional new line associations (replaces existing).	None
**phone_data	Unpack[UpdatePhone]	Keyword arguments for the updatePhone operation. Must include name or uuid to identify the phone.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the phone does not exist.
AXLError	On other AXL faults.

Example::

client.update_phone(
    name="SEP001122334455",
    description="Updated Phone",
)

remove_phone

remove_phone(name: str) -> Dict[str, Any]

Remove a phone device by name.

Parameters:

Name	Type	Description	Default
name	str	The device name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the phone does not exist.
AXLError	On other AXL faults.

list_phones

list_phones(returned_tags: Optional[Dict[str, str]] = None, **search_criteria) -> Dict[str, Dict[str, Any]]

List phones matching the given search criteria.

Parameters:

Name	Type	Description	Default
returned_tags	Optional[Dict[str, str]]	Dict of tags to include in the response. Defaults to name, description, devicePoolName.	None
**search_criteria		One or more of name, description, protocol, callingSearchSpaceName, devicePoolName, securityProfileName. Values may contain % wildcards.	{}

Returns:

Type	Description
Dict[str, Dict[str, Any]]	A dict keyed by device name.

Raises:

Type	Description
AXLError	On AXL faults.

Example::

phones = client.list_phones(name="SEP%")
for name, info in phones.items():
    print(name, info['description'])

get_route_partition

get_route_partition(name: str, returned_tags: Optional[Dict[str, str]] = None) -> Dict[str, Any]

Retrieve a route partition by name.

Parameters:

Name	Type	Description	Default
name	str	The partition name.	required
returned_tags	Optional[Dict[str, str]]	Optional dict of tags to return.	None

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the partition does not exist.
AXLError	On other AXL faults.

add_route_partition

add_route_partition(name: str, description: str = '') -> Dict[str, Any]

Add a new route partition.

Parameters:

Name	Type	Description	Default
name	str	Name for the partition.	required
description	str	Optional description.	''

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a partition with this name already exists.
AXLError	On other AXL faults.

add_route_partitions

add_route_partitions(partitions: Sequence[Union[str, Dict[str, str]]]) -> List[Dict[str, Any]]

Add multiple route partitions in sequence.

Parameters:

Name	Type	Description	Default
partitions	Sequence[Union[str, Dict[str, str]]]	A list where each element is either a partition name (str) or a dict with name and description keys.	required

Returns:

Type	Description
List[Dict[str, Any]]	A list of AXL response dicts, one per partition. Failed
List[Dict[str, Any]]	entries will have a fault key with the exception.

Example::

results = client.add_route_partitions([
    "Internal-PT",
    {"name": "PSTN-PT", "description": "PSTN Partition"},
])

remove_route_partition

remove_route_partition(name: str) -> Dict[str, Any]

Remove a route partition by name.

Parameters:

Name	Type	Description	Default
name	str	The partition name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the partition does not exist.
AXLError	On other AXL faults.

get_css

get_css(name: str) -> Dict[str, Any]

Retrieve a Calling Search Space by name.

Parameters:

Name	Type	Description	Default
name	str	The CSS name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the CSS does not exist.
AXLError	On other AXL faults.

add_css

add_css(name: str, description: str, partitions: Sequence[str]) -> Dict[str, Any]

Add a new Calling Search Space.

Parameters:

Name	Type	Description	Default
name	str	Name for the CSS.	required
description	str	Description of the CSS.	required
partitions	Sequence[str]	Ordered list of route partition names to include.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a CSS with this name already exists.
AXLError	On other AXL faults.

Example::

client.add_css(
    "Internal-CSS",
    "Internal dialing",
    ["Internal-PT", "Emergency-PT"],
)

update_css

update_css(name: str, description: Optional[str] = None, partitions: Optional[Sequence[str]] = None) -> Dict[str, Any]

Update an existing Calling Search Space.

Parameters:

Name	Type	Description	Default
name	str	The CSS name to update.	required
description	Optional[str]	New description (if provided).	None
partitions	Optional[Sequence[str]]	New ordered list of partition names (if provided).	None

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the CSS does not exist.
AXLError	On other AXL faults.

remove_css

remove_css(name: str) -> Dict[str, Any]

Remove a Calling Search Space by name.

Parameters:

Name	Type	Description	Default
name	str	The CSS name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the CSS does not exist.
AXLError	On other AXL faults.

get_route_group

get_route_group(name: str) -> Dict[str, Any]

Retrieve a Route Group by name.

Parameters:

Name	Type	Description	Default
name	str	The Route Group name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the route group does not exist.
AXLError	On other AXL faults.

add_route_group

add_route_group(name: str, distribution_algorithm: str, devices: Sequence[str]) -> Dict[str, Any]

Add a new Route Group.

Parameters:

Name	Type	Description	Default
name	str	Name for the Route Group.	required
distribution_algorithm	str	Distribution algorithm ("Top Down", "Circular", or "Longest Idle Time").	required
devices	Sequence[str]	Ordered list of gateway/trunk device names.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a route group with this name already exists.
AXLError	On other AXL faults.

Example::

client.add_route_group(
    "PSTN-RG",
    "Top Down",
    ["PSTN-GW-1", "PSTN-GW-2"],
)

update_route_group

update_route_group(name: str, distribution_algorithm: Optional[str] = None, devices: Optional[Sequence[str]] = None) -> Dict[str, Any]

Update an existing Route Group.

Parameters:

Name	Type	Description	Default
name	str	Name of the Route Group to update.	required
distribution_algorithm	Optional[str]	New algorithm (if provided).	None
devices	Optional[Sequence[str]]	New ordered list of device names (if provided).	None

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the route group does not exist.
AXLError	On other AXL faults.

remove_route_group

remove_route_group(name: str) -> Dict[str, Any]

Remove a Route Group by name.

Parameters:

Name	Type	Description	Default
name	str	The Route Group name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the route group does not exist.
AXLError	On other AXL faults.

get_route_list

get_route_list(name: str) -> Dict[str, Any]

Retrieve a Route List by name.

Parameters:

Name	Type	Description	Default
name	str	The Route List name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the route list does not exist.
AXLError	On other AXL faults.

add_route_list

add_route_list(name: str, description: str, call_manager_group_name: str, route_list_enabled: bool, run_on_every_node: bool, route_groups: Sequence[str], digit_discard_instruction_name: Optional[str] = None) -> Dict[str, Any]

Add a new Route List.

Parameters:

Name	Type	Description	Default
name	str	Name for the Route List.	required
description	str	Description.	required
call_manager_group_name	str	The Call Manager Group to associate.	required
route_list_enabled	bool	Whether the route list is enabled.	required
run_on_every_node	bool	Whether to run on every node.	required
route_groups	Sequence[str]	Ordered list of Route Group names.	required
digit_discard_instruction_name	Optional[str]	Optional DDI to apply to all members.	None

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a route list with this name exists.
AXLError	On other AXL faults.

update_route_list

update_route_list(**route_list_data: Unpack[UpdateRouteList]) -> Dict[str, Any]

Update an existing Route List.

Parameters:

Name	Type	Description	Default
**route_list_data	Unpack[UpdateRouteList]	Keyword arguments for updateRouteList. Must include name or uuid to identify the list.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the route list does not exist.
AXLError	On other AXL faults.

remove_route_list

remove_route_list(name: str) -> Dict[str, Any]

Remove a Route List by name.

Parameters:

Name	Type	Description	Default
name	str	The Route List name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the route list does not exist.
AXLError	On other AXL faults.

get_route_pattern

get_route_pattern(pattern: str, route_partition_name: str) -> Dict[str, Any]

Retrieve a Route Pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The route pattern string (e.g. "9.!").	required
route_partition_name	str	The partition the pattern belongs to.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the pattern does not exist.
AXLError	On other AXL faults.

add_route_pattern

add_route_pattern(pattern: str, route_partition_name: str, route_list_name: str, network_location: str = 'OnNet', provide_outside_dialtone: bool = False, block_enable: bool = False, use_calling_party_phone_mask: str = 'Off') -> Dict[str, Any]

Add a new Route Pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The route pattern string (e.g. "9.!").	required
route_partition_name	str	The partition to assign the pattern to.	required
route_list_name	str	The Route List to route calls through.	required
network_location	str	"OnNet" or "OffNet" (default "OnNet").	'OnNet'
provide_outside_dialtone	bool	Whether to provide outside dial tone.	False
block_enable	bool	Whether the pattern is blocked.	False

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If the route pattern already exists.
AXLError	On other AXL faults.

update_route_pattern

update_route_pattern(**route_pattern_data: Unpack[UpdateRoutePattern]) -> Dict[str, Any]

Update an existing Route Pattern.

Parameters:

Name	Type	Description	Default
**route_pattern_data	Unpack[UpdateRoutePattern]	Keyword arguments for updateRoutePattern. Must include pattern + routePartitionName or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the pattern does not exist.
AXLError	On other AXL faults.

remove_route_pattern

remove_route_pattern(pattern: str, route_partition_name: str) -> Dict[str, Any]

Remove a Route Pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The route pattern string.	required
route_partition_name	str	The partition the pattern belongs to.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the pattern does not exist.
AXLError	On other AXL faults.

get_translation_pattern

get_translation_pattern(pattern: str, route_partition_name: str) -> Dict[str, Any]

Retrieve a Translation Pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The translation pattern string.	required
route_partition_name	str	The partition the pattern belongs to.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the pattern does not exist.
AXLError	On other AXL faults.

add_translation_pattern

add_translation_pattern(pattern: str, route_partition_name: str, provide_outside_dialtone: bool = False, block_enable: bool = False, usage: str = 'Translation', **kwargs) -> Dict[str, Any]

Add a new Translation Pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The translation pattern string.	required
route_partition_name	str	The partition to assign the pattern to.	required
provide_outside_dialtone	bool	Whether to provide outside dial tone.	False
block_enable	bool	Whether the pattern is blocked.	False
usage	str	"Translation" or "Device".	'Translation'
**kwargs		Additional fields for the transPattern element (e.g. callingSearchSpaceName, calledPartyTransformationMask).	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If the pattern already exists.
AXLError	On other AXL faults.

update_translation_pattern

update_translation_pattern(**trans_data: Unpack[UpdateTransPattern]) -> Dict[str, Any]

Update an existing Translation Pattern.

Parameters:

Name	Type	Description	Default
**trans_data	Unpack[UpdateTransPattern]	Keyword arguments for updateTransPattern. Must include pattern + routePartitionName or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the pattern does not exist.
AXLError	On other AXL faults.

remove_translation_pattern

remove_translation_pattern(pattern: str, route_partition_name: str) -> Dict[str, Any]

Remove a Translation Pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The translation pattern string.	required
route_partition_name	str	The partition the pattern belongs to.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the pattern does not exist.
AXLError	On other AXL faults.

get_sip_route_pattern

get_sip_route_pattern(pattern: str, route_partition_name: str) -> Dict[str, Any]

Retrieve a SIP Route Pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The SIP route pattern string.	required
route_partition_name	str	The partition the pattern belongs to.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the pattern does not exist.
AXLError	On other AXL faults.

add_sip_route_pattern

add_sip_route_pattern(pattern: str, route_partition_name: str, sip_trunk_name: str, usage: str = 'Domain Routing') -> Dict[str, Any]

Add a new SIP Route Pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The SIP route pattern string.	required
route_partition_name	str	The partition.	required
sip_trunk_name	str	The SIP Trunk to route to.	required
usage	str	"Domain Routing" (default) or "IP Routing".	'Domain Routing'

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If the pattern already exists.
AXLError	On other AXL faults.

update_sip_route_pattern

update_sip_route_pattern(**sip_rp_data: Unpack[UpdateSipRoutePattern]) -> Dict[str, Any]

Update an existing SIP Route Pattern.

Parameters:

Name	Type	Description	Default
**sip_rp_data	Unpack[UpdateSipRoutePattern]	Keyword arguments for updateSipRoutePattern. Must include pattern + routePartitionName or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the pattern does not exist.
AXLError	On other AXL faults.

remove_sip_route_pattern

remove_sip_route_pattern(pattern: str, route_partition_name: str) -> Dict[str, Any]

Remove a SIP Route Pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The SIP route pattern string.	required
route_partition_name	str	The partition.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the pattern does not exist.
AXLError	On other AXL faults.

get_conference_bridge

get_conference_bridge(name: str) -> Dict[str, Any]

Retrieve a Conference Bridge by name.

Parameters:

Name	Type	Description	Default
name	str	The conference bridge name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the bridge does not exist.
AXLError	On other AXL faults.

add_conference_bridge

add_conference_bridge(conference_bridge_data: ConferenceBridge) -> Dict[str, Any]

Add a new Conference Bridge.

Parameters:

Name	Type	Description	Default
conference_bridge_data	ConferenceBridge	A dict describing the bridge. Required keys depend on the product type.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a bridge with this name already exists.
AXLError	On other AXL faults.

add_conference_bridge_cms

add_conference_bridge_cms(name: str, description: str, conference_bridge_prefix: str, sip_trunk_name: str, security_icon_control: bool, override_sip_trunk_address: bool, addresses: List[str], username: str, password: str, http_port: int) -> Dict[str, Any]

Add a Cisco Meeting Server (CMS) Conference Bridge.

This is a convenience method that builds the correct data structure for a CMS-type conference bridge.

Parameters:

Name	Type	Description	Default
name	str	Conference bridge name.	required
description	str	Description.	required
conference_bridge_prefix	str	Numeric prefix for conference IDs.	required
sip_trunk_name	str	Name of the SIP Trunk pointing to CMS.	required
security_icon_control	bool	Allow CFB to control call security icon.	required
override_sip_trunk_address	bool	Override SIP Trunk destination.	required
addresses	List[str]	List of address strings (e.g. ["10.0.0.1"]).	required
username	str	CMS API username.	required
password	str	CMS API password.	required
http_port	int	CMS API HTTP port.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_conference_bridge

update_conference_bridge(**cfb_data: Unpack[UpdateConferenceBridge]) -> Dict[str, Any]

Update an existing Conference Bridge.

Parameters:

Name	Type	Description	Default
**cfb_data	Unpack[UpdateConferenceBridge]	Keyword arguments for updateConferenceBridge. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the bridge does not exist.
AXLError	On other AXL faults.

remove_conference_bridge

remove_conference_bridge(name: str) -> Dict[str, Any]

Remove a Conference Bridge by name.

Parameters:

Name	Type	Description	Default
name	str	The conference bridge name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the bridge does not exist.
AXLError	On other AXL faults.

get_media_resource_group

get_media_resource_group(name: str) -> Dict[str, Any]

Retrieve a Media Resource Group by name.

Parameters:

Name	Type	Description	Default
name	str	The MRG name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the MRG does not exist.
AXLError	On other AXL faults.

add_media_resource_group

add_media_resource_group(name: str, description: str = '', devices: Optional[Sequence[str]] = None, multicast: bool = False) -> Dict[str, Any]

Add a new Media Resource Group.

Parameters:

Name	Type	Description	Default
name	str	Name for the MRG.	required
description	str	Optional description.	''
devices	Optional[Sequence[str]]	Optional list of media resource device names.	None
multicast	bool	Whether multicast is enabled for the MRG.	False

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If an MRG with this name already exists.
AXLError	On other AXL faults.

remove_media_resource_group

remove_media_resource_group(name: str) -> Dict[str, Any]

Remove a Media Resource Group by name.

Parameters:

Name	Type	Description	Default
name	str	The MRG name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the MRG does not exist.
AXLError	On other AXL faults.

get_media_resource_list

get_media_resource_list(name: str) -> Dict[str, Any]

Retrieve a Media Resource Group List (MRGL) by name.

Parameters:

Name	Type	Description	Default
name	str	The MRGL name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the MRGL does not exist.
AXLError	On other AXL faults.

add_media_resource_list

add_media_resource_list(name: str, members: Optional[Sequence[str]] = None) -> Dict[str, Any]

Add a new Media Resource Group List (MRGL).

Parameters:

Name	Type	Description	Default
name	str	Name for the MRGL.	required
members	Optional[Sequence[str]]	Optional ordered list of Media Resource Group names.	None

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If an MRGL with this name already exists.
AXLError	On other AXL faults.

remove_media_resource_list

remove_media_resource_list(name: str) -> Dict[str, Any]

Remove a Media Resource Group List (MRGL) by name.

Parameters:

Name	Type	Description	Default
name	str	The MRGL name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the MRGL does not exist.
AXLError	On other AXL faults.

get_device_pool

get_device_pool(name: str) -> Dict[str, Any]

Retrieve a Device Pool by name.

Parameters:

Name	Type	Description	Default
name	str	The Device Pool name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the device pool does not exist.
AXLError	On other AXL faults.

add_device_pool

add_device_pool(device_pool_data: DevicePool) -> Dict[str, Any]

Add a new Device Pool.

Parameters:

Name	Type	Description	Default
device_pool_data	DevicePool	A dict describing the device pool. Required keys: name, callManagerGroupName, dateTimeSettingName, regionName, srstName. Example:: { "name": "DP-Building-A", "callManagerGroupName": "CMGroup-1", "dateTimeSettingName": "CMLocal", "regionName": "Default", "locationName": "Hub_None", "srstName": "Disable", }	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a device pool with this name exists.
AXLError	On other AXL faults.

update_device_pool

update_device_pool(**device_pool_data: Unpack[UpdateDevicePool]) -> Dict[str, Any]

Update an existing Device Pool.

Parameters:

Name	Type	Description	Default
**device_pool_data	Unpack[UpdateDevicePool]	Keyword arguments for updateDevicePool. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the device pool does not exist.
AXLError	On other AXL faults.

remove_device_pool

remove_device_pool(name: str) -> Dict[str, Any]

Remove a Device Pool by name.

Parameters:

Name	Type	Description	Default
name	str	The Device Pool name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the device pool does not exist.
AXLError	On other AXL faults.

get_ldap_filter

get_ldap_filter(name: str) -> Dict[str, Any]

Retrieve an LDAP Filter by name.

Parameters:

Name	Type	Description	Default
name	str	The LDAP filter name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the filter does not exist.
AXLError	On other AXL faults.

add_ldap_filter

add_ldap_filter(name: str, filter_string: str) -> Dict[str, Any]

Add a new LDAP Filter.

Parameters:

Name	Type	Description	Default
name	str	Name for the LDAP filter.	required
filter_string	str	The LDAP filter expression.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a filter with this name already exists.
AXLError	On other AXL faults.

remove_ldap_filter

remove_ldap_filter(name: str) -> Dict[str, Any]

Remove an LDAP Filter by name.

Parameters:

Name	Type	Description	Default
name	str	The LDAP filter name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the filter does not exist.
AXLError	On other AXL faults.

get_ldap_directory

get_ldap_directory(name: str) -> Dict[str, Any]

Retrieve an LDAP Directory by name.

Parameters:

Name	Type	Description	Default
name	str	The LDAP directory name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the directory does not exist.
AXLError	On other AXL faults.

add_ldap_directory

add_ldap_directory(ldap_directory_data: LdapDirectory) -> Dict[str, Any]

Add a new LDAP Directory.

Parameters:

Name	Type	Description	Default
ldap_directory_data	LdapDirectory	A dict describing the LDAP directory configuration.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a directory with this name already exists.
AXLError	On other AXL faults.

remove_ldap_directory

remove_ldap_directory(name: str) -> Dict[str, Any]

Remove an LDAP Directory by name.

Parameters:

Name	Type	Description	Default
name	str	The LDAP directory name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the directory does not exist.
AXLError	On other AXL faults.

start_ldap_sync

start_ldap_sync(ldap_name: Optional[str] = None) -> bool

Trigger an LDAP synchronization via Thin AXL.

Parameters:

Name	Type	Description	Default
ldap_name	Optional[str]	Optional name of a specific LDAP directory to sync. If None, syncs all directories.	None

Returns:

Type	Description
bool	True if at least one row was updated.

Raises:

Type	Description
AXLSQLError	If the SQL update fails.

get_ldap_system

get_ldap_system() -> Dict[str, Any]

Retrieve the LDAP System configuration.

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ldap_system

update_ldap_system(sync_enabled: bool, ldap_server: str, user_id_attribute: str) -> Dict[str, Any]

Update the LDAP System configuration.

Parameters:

Name	Type	Description	Default
sync_enabled	bool	Whether LDAP sync is enabled.	required
ldap_server	str	The LDAP server type (e.g. "Microsoft Active Directory").	required
user_id_attribute	str	Attribute to use as user ID (e.g. "sAMAccountName").	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ldap_authentication

get_ldap_authentication() -> Dict[str, Any]

Retrieve the LDAP Authentication configuration.

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ldap_authentication

update_ldap_authentication(enabled: bool, distinguished_name: str, ldap_password: str, search_base: str, servers: Sequence[str], port: int = 389, ssl_enabled: bool = False) -> Dict[str, Any]

Update the LDAP Authentication configuration.

Parameters:

Name	Type	Description	Default
enabled	bool	Whether to authenticate end users via LDAP.	required
distinguished_name	str	Bind DN for LDAP.	required
ldap_password	str	Bind password.	required
search_base	str	LDAP search base for user lookup.	required
servers	Sequence[str]	List of LDAP server hostnames or IPs.	required
port	int	LDAP port number (default 389).	389
ssl_enabled	bool	Whether to use SSL/TLS (default False).	False

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_phone_security_profile

get_phone_security_profile(name: str) -> Dict[str, Any]

Retrieve a Phone Security Profile by name.

Parameters:

Name	Type	Description	Default
name	str	The security profile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the profile does not exist.
AXLError	On other AXL faults.

add_phone_security_profile

add_phone_security_profile(phone_type: str, protocol: str, name: str, description: str = '', device_security_mode: str = 'Non Secure', authentication_mode: str = 'By Null String', key_size: str = '1024', key_order: str = 'RSA Only', ec_key_size: str = '384', tftp_encrypted_config: bool = False, nonce_validity_time: int = 600, transport_type: str = 'TCP+UDP', sip_phone_port: int = 5060, enable_digest_authentication: bool = False) -> Dict[str, Any]

Add a new Phone Security Profile.

Parameters:

Name	Type	Description	Default
phone_type	str	Phone model (e.g. "Cisco 8845").	required
protocol	str	"SIP" or "SCCP".	required
name	str	Profile name.	required
description	str	Optional description.	''
device_security_mode	str	"Non Secure", "Authenticated", or "Encrypted".	'Non Secure'
authentication_mode	str	"By Null String", "By Existing Certificate", etc.	'By Null String'
key_size	str	RSA key size ("1024", "2048", "4096").	'1024'
key_order	str	"RSA Only" or "ECDSA Preferred".	'RSA Only'
ec_key_size	str	EC key size ("256", "384", "521").	'384'
tftp_encrypted_config	bool	Whether TFTP config is encrypted.	False
nonce_validity_time	int	Nonce validity in seconds.	600
transport_type	str	"TCP+UDP", "TCP", or "TLS".	'TCP+UDP'
sip_phone_port	int	SIP signaling port.	5060
enable_digest_authentication	bool	Whether digest auth is enabled.	False

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_sip_trunk_security_profile

get_sip_trunk_security_profile(name: str) -> Dict[str, Any]

Retrieve a SIP Trunk Security Profile by name.

Parameters:

Name	Type	Description	Default
name	str	The profile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the profile does not exist.
AXLError	On other AXL faults.

add_sip_trunk_security_profile

add_sip_trunk_security_profile(name: str, description: str = '', security_mode: str = 'Non Secure', incoming_transport: str = 'TCP+UDP', outgoing_transport: str = 'TCP', digest_authentication: bool = False, nonce_policy_time: int = 600, x509_subject_name: str = '', incoming_port: int = 5060, app_level_authentication: bool = False, accept_presence_subscription: bool = False, accept_out_of_dialog_refer: bool = False, accept_unsolicited_notification: bool = False, allow_replace_header: bool = False, transmit_security_status: bool = False, sip_v150_outbound_sdp_offer_filtering: str = 'Use Default Filter', allow_charging_header: bool = False) -> Dict[str, Any]

Add a new SIP Trunk Security Profile.

Parameters:

Name	Type	Description	Default
name	str	Profile name.	required
description	str	Optional description.	''
security_mode	str	"Non Secure", "Authenticated", or "Encrypted".	'Non Secure'
incoming_transport	str	"TCP+UDP", "TCP", or "TLS".	'TCP+UDP'
outgoing_transport	str	"TCP", "UDP", or "TLS".	'TCP'
digest_authentication	bool	Enable digest auth.	False
nonce_policy_time	int	Nonce validity in seconds.	600
x509_subject_name	str	X.509 subject name for TLS.	''
incoming_port	int	Incoming SIP port.	5060
app_level_authentication	bool	Enable application-level auth.	False
accept_presence_subscription	bool	Accept presence subscriptions.	False
accept_out_of_dialog_refer	bool	Accept out-of-dialog REFER.	False
accept_unsolicited_notification	bool	Accept unsolicited NOTIFY.	False
allow_replace_header	bool	Allow Replaces header.	False
transmit_security_status	bool	Transmit security status.	False
sip_v150_outbound_sdp_offer_filtering	str	V.150 SDP filter mode.	'Use Default Filter'
allow_charging_header	bool	Allow charging header.	False

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

remove_sip_trunk_security_profile

remove_sip_trunk_security_profile(name: str) -> Dict[str, Any]

Remove a SIP Trunk Security Profile by name.

Parameters:

Name	Type	Description	Default
name	str	The profile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the profile does not exist.
AXLError	On other AXL faults.

get_sip_profile

get_sip_profile(name: str) -> Dict[str, Any]

Retrieve a SIP Profile by name.

Parameters:

Name	Type	Description	Default
name	str	The SIP profile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the profile does not exist.
AXLError	On other AXL faults.

add_sip_profile

add_sip_profile(sip_profile_data: SipProfile) -> Dict[str, Any]

Add a new SIP Profile.

Parameters:

Name	Type	Description	Default
sip_profile_data	SipProfile	A dict describing the SIP profile.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a profile with this name already exists.
AXLError	On other AXL faults.

update_sip_profile

update_sip_profile(**profile_data: Unpack[UpdateSipProfile]) -> Dict[str, Any]

Update an existing SIP Profile.

Parameters:

Name	Type	Description	Default
**profile_data	Unpack[UpdateSipProfile]	Keyword arguments for updateSipProfile. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the profile does not exist.
AXLError	On other AXL faults.

remove_sip_profile

remove_sip_profile(name: str) -> Dict[str, Any]

Remove a SIP Profile by name.

Parameters:

Name	Type	Description	Default
name	str	The SIP profile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the profile does not exist.
AXLError	On other AXL faults.

get_sip_trunk

get_sip_trunk(name: str) -> Dict[str, Any]

Retrieve a SIP Trunk by name.

Parameters:

Name	Type	Description	Default
name	str	The SIP trunk name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the trunk does not exist.
AXLError	On other AXL faults.

add_sip_trunk

add_sip_trunk(sip_trunk_data: SipTrunk) -> Dict[str, Any]

Add a new SIP Trunk.

Parameters:

Name	Type	Description	Default
sip_trunk_data	SipTrunk	A dict describing the SIP trunk. Required keys: name, product ("SIP Trunk"), class ("Trunk"), protocol ("SIP"), protocolSide ("Network"), devicePoolName, securityProfileName, sipProfileName, locationName, presenceGroupName. Example:: { "name": "SIP-Trunk-ITSP", "product": "SIP Trunk", "class": "Trunk", "protocol": "SIP", "protocolSide": "Network", "devicePoolName": "Default", "locationName": "Hub_None", "presenceGroupName": "Standard Presence group", "securityProfileName": "Non Secure SIP Trunk Profile", "sipProfileName": "Standard SIP Profile", "callingSearchSpaceName": "CSS-Trunk", "destinations": { "destination": [ {"addressIpv4": "10.0.0.100", "port": 5060, "sortOrder": 1} ] }, }	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a trunk with this name already exists.
AXLError	On other AXL faults.

update_sip_trunk

update_sip_trunk(**trunk_data: Unpack[UpdateSipTrunk]) -> Dict[str, Any]

Update an existing SIP Trunk.

Parameters:

Name	Type	Description	Default
**trunk_data	Unpack[UpdateSipTrunk]	Keyword arguments for updateSipTrunk. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the trunk does not exist.
AXLError	On other AXL faults.

remove_sip_trunk

remove_sip_trunk(name: str) -> Dict[str, Any]

Remove a SIP Trunk by name.

Parameters:

Name	Type	Description	Default
name	str	The SIP trunk name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the trunk does not exist.
AXLError	On other AXL faults.

reset_device

reset_device(device_name: str) -> Dict[str, Any]

Perform a hard reset on a device (full reload).

Parameters:

Name	Type	Description	Default
device_name	str	The device name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the device does not exist.
AXLError	On other AXL faults.

restart_device

restart_device(device_name: str) -> Dict[str, Any]

Perform a soft restart on a device (config refresh).

Parameters:

Name	Type	Description	Default
device_name	str	The device name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the device does not exist.
AXLError	On other AXL faults.

reset_mgcp_device

reset_mgcp_device(device_name: str) -> Dict[str, Any]

Perform a hard reset on an MGCP device.

Parameters:

Name	Type	Description	Default
device_name	str	The MGCP device name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_mgcp_device

restart_mgcp_device(device_name: str) -> Dict[str, Any]

Perform a soft restart on an MGCP device.

Parameters:

Name	Type	Description	Default
device_name	str	The MGCP device name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_remote_destination

get_remote_destination(destination: str) -> Dict[str, Any]

Retrieve a Remote Destination.

Parameters:

Name	Type	Description	Default
destination	str	The remote destination number.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the destination does not exist.
AXLError	On other AXL faults.

add_remote_destination

add_remote_destination(remote_destination_data: RemoteDestination) -> Dict[str, Any]

Add a new Remote Destination.

Parameters:

Name	Type	Description	Default
remote_destination_data	RemoteDestination	A dict describing the remote destination.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a remote destination with this name already exists.
AXLError	On other AXL faults.

Note

Older UCM versions (pre-12.5) may reject the request with an internal error if <dualModeDeviceName> is sent as a nil element (Cisco bug CSCvq98025). Omit dualModeDeviceName from remote_destination_data to avoid this on affected versions.

remove_remote_destination

remove_remote_destination(destination: str) -> Dict[str, Any]

Remove a Remote Destination.

Parameters:

Name	Type	Description	Default
destination	str	The remote destination number.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the destination does not exist.
AXLError	On other AXL faults.

sql_get_device_pkid

sql_get_device_pkid(device_name: str) -> Optional[str]

Look up a device's PKID by name.

Parameters:

Name	Type	Description	Default
device_name	str	The device name.	required

Returns:

Type	Description
Optional[str]	The PKID string, or None if not found.

Raises:

Type	Description
AXLSQLError	If the query fails.

sql_get_enduser_pkid

sql_get_enduser_pkid(userid: str) -> Optional[str]

Look up an end user's PKID by user ID.

Parameters:

Name	Type	Description	Default
userid	str	The user ID.	required

Returns:

Type	Description
Optional[str]	The PKID string, or None if not found.

Raises:

Type	Description
AXLSQLError	If the query fails.

sql_get_user_group_pkid

sql_get_user_group_pkid(group_name: str) -> Optional[str]

Look up a user group's PKID by name.

Parameters:

Name	Type	Description	Default
group_name	str	The directory group name.	required

Returns:

Type	Description
Optional[str]	The PKID string, or None if not found.

Raises:

Type	Description
AXLSQLError	If the query fails.

sql_associate_user_to_group

sql_associate_user_to_group(userid: str, group_name: str) -> bool

Associate an end user with a user group via SQL.

Parameters:

Name	Type	Description	Default
userid	str	The user ID.	required
group_name	str	The directory group name.	required

Returns:

Type	Description
bool	True if the association was created successfully.

Raises:

Type	Description
AXLSQLError	If the update fails.
ValueError	If the user or group is not found.

sql_remove_user_from_group

sql_remove_user_from_group(userid: str, group_name: str) -> bool

Remove an end user from a user group via SQL.

Parameters:

Name	Type	Description	Default
userid	str	The user ID.	required
group_name	str	The directory group name.	required

Returns:

Type	Description
bool	True if the association was removed successfully.

Raises:

Type	Description
AXLSQLError	If the update fails.
ValueError	If the user or group is not found.

sql_associate_device_to_user

sql_associate_device_to_user(device_name: str, userid: str, association_type: str = '1') -> bool

Associate a device to a user via SQL.

Parameters:

Name	Type	Description	Default
device_name	str	The device name.	required
userid	str	The user ID.	required
association_type	str	The association type code (default "1").	'1'

Returns:

Type	Description
bool	True if the association was created successfully.

Raises:

Type	Description
AXLSQLError	If the update fails.
ValueError	If the device or user is not found.

sql_update_service_parameter

sql_update_service_parameter(param_name: str, param_value: str) -> bool

Update a service parameter value via SQL.

Parameters:

Name	Type	Description	Default
param_name	str	The parameter name.	required
param_value	str	The new parameter value.	required

Returns:

Type	Description
bool	True if at least one row was updated.

Raises:

Type	Description
AXLSQLError	If the update fails.

sql_get_service_parameter

sql_get_service_parameter(param_name: str) -> Optional[List[Dict[str, Optional[str]]]]

Retrieve service parameter values via SQL.

Parameters:

Name	Type	Description	Default
param_name	str	The parameter name.	required

Returns:

Type	Description
Optional[List[Dict[str, Optional[str]]]]	A list of row dicts, or None if no matching parameter.

Raises:

Type	Description
AXLSQLError	If the query fails.

get_line_group

get_line_group(name: str) -> Dict[str, Any]

Retrieve a Line Group by name.

Parameters:

Name	Type	Description	Default
name	str	The Line Group name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the group does not exist.
AXLError	On other AXL faults.

add_line_group

add_line_group(name: str, distribution_algorithm: str = 'Top Down', rna_reversion_timeout: int = 10, hunt_algorithm_no_answer: str = 'Try next member; then, try next group in Hunt List', hunt_algorithm_busy: str = 'Try next member; then, try next group in Hunt List', hunt_algorithm_not_available: str = 'Try next member; then, try next group in Hunt List', members: Optional[Sequence[Dict[str, Any]]] = None) -> Dict[str, Any]

Add a new Line Group.

Parameters:

Name	Type	Description	Default
name	str	Name for the Line Group.	required
distribution_algorithm	str	"Top Down", "Circular", "Longest Idle Time", or "Broadcast".	'Top Down'
rna_reversion_timeout	int	Ring-no-answer timeout in seconds.	10
hunt_algorithm_no_answer	str	Action on no-answer.	'Try next member; then, try next group in Hunt List'
hunt_algorithm_busy	str	Action on busy.	'Try next member; then, try next group in Hunt List'
hunt_algorithm_not_available	str	Action when not available.	'Try next member; then, try next group in Hunt List'
members	Optional[Sequence[Dict[str, Any]]]	Optional list of member dicts. Each should include lineSelectionOrder and directoryNumber with pattern and routePartitionName:: [ { "lineSelectionOrder": 1, "directoryNumber": { "pattern": "1001", "routePartitionName": "Internal-PT", }, } ]	None

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a line group with this name already exists.
AXLError	On other AXL faults.

update_line_group

update_line_group(**line_group_data: Unpack[UpdateLineGroup]) -> Dict[str, Any]

Update an existing Line Group.

Parameters:

Name	Type	Description	Default
**line_group_data	Unpack[UpdateLineGroup]	Keyword arguments for updateLineGroup. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the group does not exist.
AXLError	On other AXL faults.

remove_line_group

remove_line_group(name: str) -> Dict[str, Any]

Remove a Line Group by name.

Parameters:

Name	Type	Description	Default
name	str	The Line Group name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the group does not exist.
AXLError	On other AXL faults.

get_hunt_list

get_hunt_list(name: str) -> Dict[str, Any]

Retrieve a Hunt List by name.

Parameters:

Name	Type	Description	Default
name	str	The Hunt List name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the hunt list does not exist.
AXLError	On other AXL faults.

add_hunt_list

add_hunt_list(name: str, description: str, call_manager_group_name: str, route_list_enabled: bool = True, voice_mail_usage_flag: str = 'true', line_groups: Optional[Sequence[str]] = None) -> Dict[str, Any]

Add a new Hunt List.

Parameters:

Name	Type	Description	Default
name	str	Name for the Hunt List.	required
description	str	Description.	required
call_manager_group_name	str	Associated Call Manager Group name.	required
route_list_enabled	bool	Whether the hunt list is enabled.	True
voice_mail_usage_flag	str	"true" or "false".	'true'
line_groups	Optional[Sequence[str]]	Optional ordered list of Line Group names.	None

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a hunt list with this name exists.
AXLError	On other AXL faults.

Example::

client.add_hunt_list(
    "HL-Support",
    "Support Hunt List",
    "CMGroup-1",
    line_groups=["LG-Support-1", "LG-Support-2"],
)

update_hunt_list

update_hunt_list(**hunt_list_data: Unpack[UpdateHuntList]) -> Dict[str, Any]

Update an existing Hunt List.

Parameters:

Name	Type	Description	Default
**hunt_list_data	Unpack[UpdateHuntList]	Keyword arguments for updateHuntList. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the hunt list does not exist.
AXLError	On other AXL faults.

remove_hunt_list

remove_hunt_list(name: str) -> Dict[str, Any]

Remove a Hunt List by name.

Parameters:

Name	Type	Description	Default
name	str	The Hunt List name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the hunt list does not exist.
AXLError	On other AXL faults.

get_hunt_pilot

get_hunt_pilot(pattern: str, route_partition_name: str) -> Dict[str, Any]

Retrieve a Hunt Pilot by pattern and partition.

Parameters:

Name	Type	Description	Default
pattern	str	The hunt pilot pattern (e.g. "2000").	required
route_partition_name	str	The partition the pilot belongs to.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the hunt pilot does not exist.
AXLError	On other AXL faults.

add_hunt_pilot

add_hunt_pilot(pattern: str, route_partition_name: str, hunt_list_name: str, description: str = '', provide_outside_dialtone: bool = False, block_enable: bool = False, use_calling_party_phone_mask: str = 'Off') -> Dict[str, Any]

Add a new Hunt Pilot.

Parameters:

Name	Type	Description	Default
pattern	str	The hunt pilot pattern.	required
route_partition_name	str	The partition.	required
hunt_list_name	str	The Hunt List to route calls to.	required
description	str	Optional description.	''
provide_outside_dialtone	bool	Whether to provide outside dial tone.	False

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If the hunt pilot already exists.
AXLError	On other AXL faults.

Example::

client.add_hunt_pilot(
    "2000", "Internal-PT", "HL-Support",
    description="Support Queue",
)

update_hunt_pilot

update_hunt_pilot(**hunt_pilot_data: Unpack[UpdateHuntPilot]) -> Dict[str, Any]

Update an existing Hunt Pilot.

Parameters:

Name	Type	Description	Default
**hunt_pilot_data	Unpack[UpdateHuntPilot]	Keyword arguments for updateHuntPilot. Must include pattern + routePartitionName or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the hunt pilot does not exist.
AXLError	On other AXL faults.

remove_hunt_pilot

remove_hunt_pilot(pattern: str, route_partition_name: str) -> Dict[str, Any]

Remove a Hunt Pilot.

Parameters:

Name	Type	Description	Default
pattern	str	The hunt pilot pattern.	required
route_partition_name	str	The partition.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the hunt pilot does not exist.
AXLError	On other AXL faults.

get_call_park

get_call_park(pattern: str, route_partition_name: str) -> Dict[str, Any]

Retrieve a Call Park number.

Parameters:

Name	Type	Description	Default
pattern	str	The call park number pattern.	required
route_partition_name	str	The partition.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_call_park

add_call_park(pattern: str, route_partition_name: str, description: str = '', call_manager_name: str = '', calling_search_space_for_single_number_retrieval: str = '') -> Dict[str, Any]

Add a new Call Park number.

Parameters:

Name	Type	Description	Default
pattern	str	The call park pattern (e.g. "3000").	required
route_partition_name	str	The partition.	required
description	str	Optional description.	''
call_manager_name	str	The CallManager to associate with.	''
calling_search_space_for_single_number_retrieval	str	CSS for call park retrieval.	''

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If the pattern already exists.
AXLError	On other AXL faults.

remove_call_park

remove_call_park(pattern: str, route_partition_name: str) -> Dict[str, Any]

Remove a Call Park number.

Parameters:

Name	Type	Description	Default
pattern	str	The call park pattern.	required
route_partition_name	str	The partition.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_call_pickup_group

get_call_pickup_group(name: str) -> Dict[str, Any]

Retrieve a Call Pickup Group by name.

Parameters:

Name	Type	Description	Default
name	str	The Call Pickup Group name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_call_pickup_group

add_call_pickup_group(name: str, pattern: str, route_partition_name: str = '', description: str = '', members: Optional[Sequence[Dict[str, Any]]] = None) -> Dict[str, Any]

Add a new Call Pickup Group.

Parameters:

Name	Type	Description	Default
name	str	Name for the group.	required
pattern	str	The pickup group number pattern.	required
route_partition_name	str	The partition (optional).	''
description	str	Optional description.	''
members	Optional[Sequence[Dict[str, Any]]]	Optional list of member line dicts.	None

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a group with this name already exists.
AXLError	On other AXL faults.

Example::

client.add_call_pickup_group(
    "Pickup-Floor1", "4000", "Internal-PT"
)

update_call_pickup_group

update_call_pickup_group(**cpg_data: Unpack[UpdateCallPickupGroup]) -> Dict[str, Any]

Update an existing Call Pickup Group.

Parameters:

Name	Type	Description	Default
**cpg_data	Unpack[UpdateCallPickupGroup]	Keyword arguments for updateCallPickupGroup. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_call_pickup_group

remove_call_pickup_group(name: str) -> Dict[str, Any]

Remove a Call Pickup Group by name.

Parameters:

Name	Type	Description	Default
name	str	The Call Pickup Group name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_region

get_region(name: str) -> Dict[str, Any]

Retrieve a Region by name.

Parameters:

Name	Type	Description	Default
name	str	The Region name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_region

add_region(name: str) -> Dict[str, Any]

Add a new Region.

Parameters:

Name	Type	Description	Default
name	str	Name for the Region.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a region with this name already exists.
AXLError	On other AXL faults.

update_region

update_region(**region_data: Unpack[UpdateRegion]) -> Dict[str, Any]

Update an existing Region.

Parameters:

Name	Type	Description	Default
**region_data	Unpack[UpdateRegion]	Keyword arguments for updateRegion. Must include name or uuid. To configure region relationships, include relatedRegions.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the region does not exist.
AXLError	On other AXL faults.

Example::

client.update_region(
    name="Region-A",
    relatedRegions={
        "relatedRegion": [
            {
                "regionName": "Region-B",
                "bandwidth": "G.711",
                "videoBandwidth": "-1",
            }
        ]
    },
)

remove_region

remove_region(name: str) -> Dict[str, Any]

Remove a Region by name.

Parameters:

Name	Type	Description	Default
name	str	The Region name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the region does not exist.
AXLError	On other AXL faults.

get_location

get_location(name: str) -> Dict[str, Any]

Retrieve a Location by name.

Parameters:

Name	Type	Description	Default
name	str	The Location name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_location

add_location(name: str, related_locations: Optional[Sequence[Dict[str, Any]]] = None, between_locations: Optional[Sequence[Dict[str, Any]]] = None, within_audio_bandwidth: int = 0, within_video_bandwidth: int = 0, within_immersive_kbits: int = 0) -> Dict[str, Any]

Add a new Location for CAC (Call Admission Control).

Parameters:

Name	Type	Description	Default
name	str	Name for the Location.	required
related_locations	Optional[Sequence[Dict[str, Any]]]	Optional list of related location dicts:: [ { "locationName": "Hub_None", "weight": 50, "audioBandwidth": 80, "videoBandwidth": 384, } ]	None
between_locations	Optional[Sequence[Dict[str, Any]]]	Optional list of between-location dicts. Defaults to a single entry for Hub_None with unlimited bandwidth (-1):: [ { "locationName": "Hub_None", "weight": 50, "audioBandwidth": -1, "videoBandwidth": 384, "immersiveBandwidth": 384, } ]	None
within_audio_bandwidth	int	Audio bandwidth within the location (0 = unlimited, -1 = no limit).	0
within_video_bandwidth	int	Video bandwidth within the location.	0
within_immersive_kbits	int	Immersive bandwidth within the location.	0

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a location with this name already exists.
AXLError	On other AXL faults.

update_location

update_location(**location_data: Unpack[UpdateLocation]) -> Dict[str, Any]

Update an existing Location.

Parameters:

Name	Type	Description	Default
**location_data	Unpack[UpdateLocation]	Keyword arguments for updateLocation. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the location does not exist.
AXLError	On other AXL faults.

remove_location

remove_location(name: str) -> Dict[str, Any]

Remove a Location by name.

Parameters:

Name	Type	Description	Default
name	str	The Location name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the location does not exist.
AXLError	On other AXL faults.

get_date_time_group

get_date_time_group(name: str) -> Dict[str, Any]

Retrieve a Date/Time Group by name.

Parameters:

Name	Type	Description	Default
name	str	The Date/Time Group name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_date_time_group

add_date_time_group(name: str, time_zone: str, separator: str = '-', date_format: str = 'M-D-Y', time_format: str = '12-hour') -> Dict[str, Any]

Add a new Date/Time Group.

Parameters:

Name	Type	Description	Default
name	str	Name for the group.	required
time_zone	str	Time zone identifier (e.g. "America/New_York").	required
separator	str	Date separator character.	'-'
date_format	str	Date format (e.g. "M-D-Y").	'M-D-Y'
time_format	str	"12-hour" or "24-hour".	'12-hour'

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a group with this name exists.
AXLError	On other AXL faults.

update_date_time_group

update_date_time_group(**dtg_data: Unpack[UpdateDateTimeGroup]) -> Dict[str, Any]

Update an existing Date/Time Group.

Parameters:

Name	Type	Description	Default
**dtg_data	Unpack[UpdateDateTimeGroup]	Keyword arguments for updateDateTimeGroup. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the group does not exist.
AXLError	On other AXL faults.

remove_date_time_group

remove_date_time_group(name: str) -> Dict[str, Any]

Remove a Date/Time Group by name.

Parameters:

Name	Type	Description	Default
name	str	The Date/Time Group name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the group does not exist.
AXLError	On other AXL faults.

get_srst

get_srst(name: str) -> Dict[str, Any]

Retrieve an SRST reference by name.

Parameters:

Name	Type	Description	Default
name	str	The SRST name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_srst

add_srst(name: str, ip_address: str, port: int = 2000, sip_port: int = 5060, is_secure: bool = False) -> Dict[str, Any]

Add a new SRST reference.

Parameters:

Name	Type	Description	Default
name	str	Name for the SRST reference.	required
ip_address	str	IP address of the SRST router.	required
port	int	SCCP port (default 2000).	2000
sip_port	int	SIP port (default 5060).	5060
is_secure	bool	Whether the SRST is secure.	False

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If an SRST with this name exists.
AXLError	On other AXL faults.

update_srst

update_srst(**srst_data: Unpack[UpdateSrst]) -> Dict[str, Any]

Update an existing SRST reference.

Parameters:

Name	Type	Description	Default
**srst_data	Unpack[UpdateSrst]	Keyword arguments for updateSrst. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the SRST does not exist.
AXLError	On other AXL faults.

remove_srst

remove_srst(name: str) -> Dict[str, Any]

Remove an SRST reference by name.

Parameters:

Name	Type	Description	Default
name	str	The SRST name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the SRST does not exist.
AXLError	On other AXL faults.

get_phone_ntp

get_phone_ntp(name: str) -> Dict[str, Any]

Retrieve a Phone NTP Reference by name.

Parameters:

Name	Type	Description	Default
name	str	The Phone NTP Reference name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_phone_ntp

add_phone_ntp(ip_address: str = '', description: str = '', mode: str = 'Unicast', ipv6_address: str = '') -> Dict[str, Any]

Add a new Phone NTP Reference.

Parameters:

Name	Type	Description	Default
ip_address	str	IPv4 address or hostname of the NTP server. Either ip_address or ipv6_address must be provided.	''
description	str	Optional description.	''
mode	str	"Unicast", "Multicast", or "Anycast".	'Unicast'
ipv6_address	str	IPv6 address of the NTP server.	''

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If this NTP reference already exists.
AXLError	On other AXL faults.

remove_phone_ntp

remove_phone_ntp(ip_address: str) -> Dict[str, Any]

Remove a Phone NTP Reference.

Parameters:

Name	Type	Description	Default
ip_address	str	IP address of the NTP reference to remove.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_common_device_config

get_common_device_config(name: str) -> Dict[str, Any]

Retrieve a Common Device Configuration by name.

Parameters:

Name	Type	Description	Default
name	str	The Common Device Config name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_common_device_config

add_common_device_config(common_device_config_data: CommonDeviceConfig) -> Dict[str, Any]

Add a new Common Device Configuration.

Parameters:

Name	Type	Description	Default
common_device_config_data	CommonDeviceConfig	A dict describing the config. Must include at minimum name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a config with this name exists.
AXLError	On other AXL faults.

update_common_device_config

update_common_device_config(**cdc_data: Unpack[UpdateCommonDeviceConfig]) -> Dict[str, Any]

Update an existing Common Device Configuration.

Parameters:

Name	Type	Description	Default
**cdc_data	Unpack[UpdateCommonDeviceConfig]	Keyword arguments for updateCommonDeviceConfig. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_common_device_config

remove_common_device_config(name: str) -> Dict[str, Any]

Remove a Common Device Configuration by name.

Parameters:

Name	Type	Description	Default
name	str	The Common Device Config name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_common_phone_config

get_common_phone_config(name: str) -> Dict[str, Any]

Retrieve a Common Phone Configuration by name.

Parameters:

Name	Type	Description	Default
name	str	The Common Phone Config name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_common_phone_config

add_common_phone_config(common_phone_config_data: CommonPhoneConfig) -> Dict[str, Any]

Add a new Common Phone Configuration.

Parameters:

Name	Type	Description	Default
common_phone_config_data	CommonPhoneConfig	A dict describing the config. Must include at minimum name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a config with this name exists.
AXLError	On other AXL faults.

update_common_phone_config

update_common_phone_config(**cpc_data: Unpack[UpdateCommonPhoneConfig]) -> Dict[str, Any]

Update an existing Common Phone Configuration.

Parameters:

Name	Type	Description	Default
**cpc_data	Unpack[UpdateCommonPhoneConfig]	Keyword arguments for updateCommonPhoneConfig. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_common_phone_config

remove_common_phone_config(name: str) -> Dict[str, Any]

Remove a Common Phone Configuration by name.

Parameters:

Name	Type	Description	Default
name	str	The Common Phone Config name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_cti_route_point

get_cti_route_point(name: str) -> Dict[str, Any]

Retrieve a CTI Route Point by name.

Parameters:

Name	Type	Description	Default
name	str	The CTI Route Point name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_cti_route_point

add_cti_route_point(cti_route_point_data: CtiRoutePoint, line_data: Optional[List[Dict[str, Any]]] = None) -> Dict[str, Any]

Add a new CTI Route Point.

Parameters:

Name	Type	Description	Default
cti_route_point_data	CtiRoutePoint	A dict describing the CTI Route Point. Required keys include name, product ("CTI Route Point"), class ("CTI Route Point"), protocol ("SCCP" or "SIP"), protocolSide ("User"), devicePoolName.	required
line_data	Optional[List[Dict[str, Any]]]	Optional list of line association dicts, same as :meth:add_phone.	None

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If the name already exists.
AXLError	On other AXL faults.

Example::

client.add_cti_route_point({
    "name": "CTI-RP-IVR",
    "product": "CTI Route Point",
    "class": "CTI Route Point",
    "protocol": "SCCP",
    "protocolSide": "User",
    "devicePoolName": "Default",
}, line_data=[
    {"index": 1, "dirn": {"pattern": "5000", "routePartitionName": "Internal-PT"}}
])

update_cti_route_point

update_cti_route_point(**cti_rp_data: Unpack[UpdateCtiRoutePoint]) -> Dict[str, Any]

Update an existing CTI Route Point.

Parameters:

Name	Type	Description	Default
**cti_rp_data	Unpack[UpdateCtiRoutePoint]	Keyword arguments for updateCtiRoutePoint. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_cti_route_point

remove_cti_route_point(name: str) -> Dict[str, Any]

Remove a CTI Route Point by name.

Parameters:

Name	Type	Description	Default
name	str	The CTI Route Point name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_h323_gateway

get_h323_gateway(name: str) -> Dict[str, Any]

Retrieve an H.323 Gateway by name.

Parameters:

Name	Type	Description	Default
name	str	The gateway name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_h323_gateway

add_h323_gateway(h323_gateway_data: H323Gateway) -> Dict[str, Any]

Add a new H.323 Gateway.

Parameters:

Name	Type	Description	Default
h323_gateway_data	H323Gateway	A dict describing the H.323 gateway.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_h323_gateway

update_h323_gateway(**gw_data: Unpack[UpdateH323Gateway]) -> Dict[str, Any]

Update an existing H.323 Gateway.

Parameters:

Name	Type	Description	Default
**gw_data	Unpack[UpdateH323Gateway]	Keyword arguments for updateH323Gateway. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_h323_gateway

remove_h323_gateway(name: str) -> Dict[str, Any]

Remove an H.323 Gateway by name.

Parameters:

Name	Type	Description	Default
name	str	The gateway name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_h323_trunk

get_h323_trunk(name: str) -> Dict[str, Any]

Retrieve an H.323 Trunk by name.

Parameters:

Name	Type	Description	Default
name	str	The trunk name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_h323_trunk

add_h323_trunk(h323_trunk_data: H323Trunk) -> Dict[str, Any]

Add a new H.323 Trunk.

Parameters:

Name	Type	Description	Default
h323_trunk_data	H323Trunk	A dict describing the H.323 trunk.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_h323_trunk

update_h323_trunk(**trunk_data: Unpack[UpdateH323Trunk]) -> Dict[str, Any]

Update an existing H.323 Trunk.

Parameters:

Name	Type	Description	Default
**trunk_data	Unpack[UpdateH323Trunk]	Keyword arguments for updateH323Trunk. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_h323_trunk

remove_h323_trunk(name: str) -> Dict[str, Any]

Remove an H.323 Trunk by name.

Parameters:

Name	Type	Description	Default
name	str	The trunk name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_transcoder

get_transcoder(name: str) -> Dict[str, Any]

Retrieve a Transcoder by name.

Parameters:

Name	Type	Description	Default
name	str	The transcoder name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_transcoder

add_transcoder(transcoder_data: Transcoder) -> Dict[str, Any]

Add a new Transcoder.

Parameters:

Name	Type	Description	Default
transcoder_data	Transcoder	A dict describing the transcoder. Required keys include name, product, devicePoolName.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a transcoder with this name exists.
AXLError	On other AXL faults.

update_transcoder

update_transcoder(**transcoder_data: Unpack[UpdateTranscoder]) -> Dict[str, Any]

Update an existing Transcoder.

Parameters:

Name	Type	Description	Default
**transcoder_data	Unpack[UpdateTranscoder]	Keyword arguments for updateTranscoder. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_transcoder

remove_transcoder(name: str) -> Dict[str, Any]

Remove a Transcoder by name.

Parameters:

Name	Type	Description	Default
name	str	The transcoder name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_mtp

get_mtp(name: str) -> Dict[str, Any]

Retrieve an MTP by name.

Parameters:

Name	Type	Description	Default
name	str	The MTP name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_mtp

add_mtp(mtp_data: Mtp) -> Dict[str, Any]

Add a new Media Termination Point (MTP).

Parameters:

Name	Type	Description	Default
mtp_data	Mtp	A dict describing the MTP. Required keys include name, product, devicePoolName.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If an MTP with this name exists.
AXLError	On other AXL faults.

update_mtp

update_mtp(**mtp_data: Unpack[UpdateMtp]) -> Dict[str, Any]

Update an existing MTP.

Parameters:

Name	Type	Description	Default
**mtp_data	Unpack[UpdateMtp]	Keyword arguments for updateMtp. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_mtp

remove_mtp(name: str) -> Dict[str, Any]

Remove an MTP by name.

Parameters:

Name	Type	Description	Default
name	str	The MTP name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_voicemail_pilot

get_voicemail_pilot(dir_n: str) -> Dict[str, Any]

Retrieve a Voicemail Pilot by directory number.

Parameters:

Name	Type	Description	Default
dir_n	str	The voicemail pilot number.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_voicemail_pilot

add_voicemail_pilot(dir_n: str, description: str = '', calling_search_space_name: str = '', is_default: bool = False) -> Dict[str, Any]

Add a new Voicemail Pilot.

Parameters:

Name	Type	Description	Default
dir_n	str	The voicemail pilot number.	required
description	str	Optional description.	''
calling_search_space_name	str	CSS for the pilot.	''
is_default	bool	Whether this is the default pilot.	False

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If the pilot already exists.
AXLError	On other AXL faults.

remove_voicemail_pilot

remove_voicemail_pilot(dir_n: str) -> Dict[str, Any]

Remove a Voicemail Pilot.

Parameters:

Name	Type	Description	Default
dir_n	str	The voicemail pilot number.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_voicemail_profile

get_voicemail_profile(name: str) -> Dict[str, Any]

Retrieve a Voicemail Profile by name.

Parameters:

Name	Type	Description	Default
name	str	The Voicemail Profile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_voicemail_profile

add_voicemail_profile(name: str, description: str = '', voicemail_pilot_name: str = '', is_default: bool = False) -> Dict[str, Any]

Add a new Voicemail Profile.

Parameters:

Name	Type	Description	Default
name	str	Name for the profile.	required
description	str	Optional description.	''
voicemail_pilot_name	str	Associated Voicemail Pilot number.	''
is_default	bool	Whether this is the default profile.	False

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a profile with this name exists.
AXLError	On other AXL faults.

remove_voicemail_profile

remove_voicemail_profile(name: str) -> Dict[str, Any]

Remove a Voicemail Profile by name.

Parameters:

Name	Type	Description	Default
name	str	The Voicemail Profile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_voicemail_port

get_voicemail_port(name: str) -> Dict[str, Any]

Retrieve a Voicemail Port by name.

Parameters:

Name	Type	Description	Default
name	str	The voicemail port device name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_voicemail_port

add_voicemail_port(voicemail_port_data: VoiceMailPort) -> Dict[str, Any]

Add a new Voicemail Port.

Parameters:

Name	Type	Description	Default
voicemail_port_data	VoiceMailPort	A dict describing the voicemail port.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

remove_voicemail_port

remove_voicemail_port(name: str) -> Dict[str, Any]

Remove a Voicemail Port by name.

Parameters:

Name	Type	Description	Default
name	str	The voicemail port device name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_app_user

get_app_user(userid: str) -> Dict[str, Any]

Retrieve an Application User by user ID.

Parameters:

Name	Type	Description	Default
userid	str	The application user ID.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the user does not exist.
AXLError	On other AXL faults.

add_app_user

add_app_user(userid: str, password: str = '', associated_devices: Optional[Sequence[str]] = None, associated_groups: Optional[Sequence[str]] = None, **kwargs) -> Dict[str, Any]

Add a new Application User.

Parameters:

Name	Type	Description	Default
userid	str	The application user ID.	required
password	str	Password for the user.	''
associated_devices	Optional[Sequence[str]]	Optional list of device names to associate.	None
associated_groups	Optional[Sequence[str]]	Optional list of user group names to assign.	None
**kwargs		Additional fields for addAppUser.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If the user already exists.
AXLError	On other AXL faults.

Example::

client.add_app_user(
    "jtapi_user",
    password="secret",
    associated_devices=["CTI-RP-IVR"],
    associated_groups=["Standard CTI Enabled"],
)

update_app_user

update_app_user(**app_user_data: Unpack[UpdateAppUser]) -> Dict[str, Any]

Update an existing Application User.

Parameters:

Name	Type	Description	Default
**app_user_data	Unpack[UpdateAppUser]	Keyword arguments for updateAppUser. Must include userid or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the user does not exist.
AXLError	On other AXL faults.

remove_app_user

remove_app_user(userid: str) -> Dict[str, Any]

Remove an Application User by user ID.

Parameters:

Name	Type	Description	Default
userid	str	The application user ID.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the user does not exist.
AXLError	On other AXL faults.

get_user_group

get_user_group(name: str) -> Dict[str, Any]

Retrieve a User Group (Access Control Group) by name.

Parameters:

Name	Type	Description	Default
name	str	The User Group name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_user_group

add_user_group(name: str, members: Optional[Sequence[str]] = None) -> Dict[str, Any]

Add a new User Group (Access Control Group).

Parameters:

Name	Type	Description	Default
name	str	Name for the User Group.	required
members	Optional[Sequence[str]]	Optional list of user IDs to include.	None

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a group with this name exists.
AXLError	On other AXL faults.

update_user_group

update_user_group(**ug_data: Unpack[UpdateUserGroup]) -> Dict[str, Any]

Update an existing User Group.

Parameters:

Name	Type	Description	Default
**ug_data	Unpack[UpdateUserGroup]	Keyword arguments for updateUserGroup. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_user_group

remove_user_group(name: str) -> Dict[str, Any]

Remove a User Group by name.

Parameters:

Name	Type	Description	Default
name	str	The User Group name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_device_profile

get_device_profile(name: str) -> Dict[str, Any]

Retrieve a Device Profile (Extension Mobility) by name.

Parameters:

Name	Type	Description	Default
name	str	The device profile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_device_profile

add_device_profile(device_profile_data: DeviceProfile, line_data: Optional[List[Dict[str, Any]]] = None) -> Dict[str, Any]

Add a new Device Profile for Extension Mobility.

Parameters:

Name	Type	Description	Default
device_profile_data	DeviceProfile	A dict describing the profile. Required keys include name, product, class ("Device Profile"), protocol, protocolSide ("User"), phoneTemplateName.	required
line_data	Optional[List[Dict[str, Any]]]	Optional list of line association dicts.	None

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If the name already exists.
AXLError	On other AXL faults.

Example::

client.add_device_profile({
    "name": "DP-jsmith-8845",
    "product": "Cisco 8845",
    "class": "Device Profile",
    "protocol": "SIP",
    "protocolSide": "User",
    "phoneTemplateName": "Standard 8845 SIP",
}, line_data=[
    {"index": 1, "dirn": {"pattern": "1001", "routePartitionName": "Internal-PT"}}
])

update_device_profile

update_device_profile(**dp_data: Unpack[UpdateDeviceProfile]) -> Dict[str, Any]

Update an existing Device Profile.

Parameters:

Name	Type	Description	Default
**dp_data	Unpack[UpdateDeviceProfile]	Keyword arguments for updateDeviceProfile. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_device_profile

remove_device_profile(name: str) -> Dict[str, Any]

Remove a Device Profile by name.

Parameters:

Name	Type	Description	Default
name	str	The device profile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_route_filter

get_route_filter(name: str) -> Dict[str, Any]

Retrieve a Route Filter by name.

Parameters:

Name	Type	Description	Default
name	str	The Route Filter name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_route_filter

add_route_filter(route_filter_data: RouteFilter) -> Dict[str, Any]

Add a new Route Filter.

Parameters:

Name	Type	Description	Default
route_filter_data	RouteFilter	A dict describing the route filter. Must include name and dialPlanName.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a filter with this name exists.
AXLError	On other AXL faults.

update_route_filter

update_route_filter(**rf_data: Unpack[UpdateRouteFilter]) -> Dict[str, Any]

Update an existing Route Filter.

Parameters:

Name	Type	Description	Default
**rf_data	Unpack[UpdateRouteFilter]	Keyword arguments for updateRouteFilter. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_route_filter

remove_route_filter(name: str) -> Dict[str, Any]

Remove a Route Filter by name.

Parameters:

Name	Type	Description	Default
name	str	The Route Filter name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_calling_party_transformation_pattern

get_calling_party_transformation_pattern(pattern: str, route_partition_name: str) -> Dict[str, Any]

Retrieve a Calling Party Transformation Pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The pattern string.	required
route_partition_name	str	The partition.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_calling_party_transformation_pattern

add_calling_party_transformation_pattern(pattern: str, route_partition_name: str, calling_party_transformation_mask: str = '', calling_party_prefix_digits: str = '', **kwargs) -> Dict[str, Any]

Add a new Calling Party Transformation Pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The pattern string.	required
route_partition_name	str	The partition.	required
calling_party_transformation_mask	str	Transformation mask.	''
calling_party_prefix_digits	str	Prefix digits.	''
**kwargs		Additional fields.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If the pattern already exists.
AXLError	On other AXL faults.

remove_calling_party_transformation_pattern

remove_calling_party_transformation_pattern(pattern: str, route_partition_name: str) -> Dict[str, Any]

Remove a Calling Party Transformation Pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The pattern string.	required
route_partition_name	str	The partition.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_called_party_transformation_pattern

get_called_party_transformation_pattern(pattern: str, route_partition_name: str) -> Dict[str, Any]

Retrieve a Called Party Transformation Pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The pattern string.	required
route_partition_name	str	The partition.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_called_party_transformation_pattern

add_called_party_transformation_pattern(pattern: str, route_partition_name: str, called_party_transformation_mask: str = '', called_party_prefix_digits: str = '', **kwargs) -> Dict[str, Any]

Add a new Called Party Transformation Pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The pattern string.	required
route_partition_name	str	The partition.	required
called_party_transformation_mask	str	Transformation mask.	''
called_party_prefix_digits	str	Prefix digits.	''
**kwargs		Additional fields.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If the pattern already exists.
AXLError	On other AXL faults.

remove_called_party_transformation_pattern

remove_called_party_transformation_pattern(pattern: str, route_partition_name: str) -> Dict[str, Any]

Remove a Called Party Transformation Pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The pattern string.	required
route_partition_name	str	The partition.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_presence_group

get_presence_group(name: str) -> Dict[str, Any]

Retrieve a Presence Group by name.

Parameters:

Name	Type	Description	Default
name	str	The Presence Group name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_presence_group

add_presence_group(name: str, description: str = '') -> Dict[str, Any]

Add a new Presence Group.

Parameters:

Name	Type	Description	Default
name	str	Name for the Presence Group.	required
description	str	Optional description.	''

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If a group with this name exists.
AXLError	On other AXL faults.

remove_presence_group

remove_presence_group(name: str) -> Dict[str, Any]

Remove a Presence Group by name.

Parameters:

Name	Type	Description	Default
name	str	The Presence Group name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_credential_policy

get_credential_policy(name: str) -> Dict[str, Any]

Retrieve a Credential Policy by name.

Parameters:

Name	Type	Description	Default
name	str	The Credential Policy name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

update_credential_policy

update_credential_policy(**cp_data: Unpack[UpdateCredentialPolicy]) -> Dict[str, Any]

Update an existing Credential Policy.

Parameters:

Name	Type	Description	Default
**cp_data	Unpack[UpdateCredentialPolicy]	Keyword arguments for updateCredentialPolicy. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_phone_button_template

get_phone_button_template(name: str) -> Dict[str, Any]

Retrieve a Phone Button Template by name.

Parameters:

Name	Type	Description	Default
name	str	The Phone Button Template name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_phone_button_template

add_phone_button_template(phone_button_template_data: PhoneButtonTemplate) -> Dict[str, Any]

Add a new Phone Button Template.

Parameters:

Name	Type	Description	Default
phone_button_template_data	PhoneButtonTemplate	A dict describing the template.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If the template already exists.
AXLError	On other AXL faults.

update_phone_button_template

update_phone_button_template(**pbt_data: Unpack[UpdatePhoneButtonTemplate]) -> Dict[str, Any]

Update an existing Phone Button Template.

Parameters:

Name	Type	Description	Default
**pbt_data	Unpack[UpdatePhoneButtonTemplate]	Keyword arguments for updatePhoneButtonTemplate. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_phone_button_template

remove_phone_button_template(name: str) -> Dict[str, Any]

Remove a Phone Button Template by name.

Parameters:

Name	Type	Description	Default
name	str	The Phone Button Template name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_soft_key_template

get_soft_key_template(name: str) -> Dict[str, Any]

Retrieve a Soft Key Template by name.

Parameters:

Name	Type	Description	Default
name	str	The Soft Key Template name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_soft_key_template

add_soft_key_template(soft_key_template_data: SoftKeyTemplate) -> Dict[str, Any]

Add a new Soft Key Template.

Parameters:

Name	Type	Description	Default
soft_key_template_data	SoftKeyTemplate	A dict describing the template.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If the template already exists.
AXLError	On other AXL faults.

remove_soft_key_template

remove_soft_key_template(name: str) -> Dict[str, Any]

Remove a Soft Key Template by name.

Parameters:

Name	Type	Description	Default
name	str	The Soft Key Template name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_service_profile

get_service_profile(name: str) -> Dict[str, Any]

Retrieve a Service Profile by name.

Parameters:

Name	Type	Description	Default
name	str	The Service Profile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_service_profile

add_service_profile(service_profile_data: ServiceProfile) -> Dict[str, Any]

Add a new Service Profile.

Parameters:

Name	Type	Description	Default
service_profile_data	ServiceProfile	A dict describing the profile.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If the profile already exists.
AXLError	On other AXL faults.

update_service_profile

update_service_profile(**sp_data: Unpack[UpdateServiceProfile]) -> Dict[str, Any]

Update an existing Service Profile.

Parameters:

Name	Type	Description	Default
**sp_data	Unpack[UpdateServiceProfile]	Keyword arguments for updateServiceProfile. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_service_profile

remove_service_profile(name: str) -> Dict[str, Any]

Remove a Service Profile by name.

Parameters:

Name	Type	Description	Default
name	str	The Service Profile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_uc_service

get_uc_service(name: str) -> Dict[str, Any]

Retrieve a UC Service by name.

Parameters:

Name	Type	Description	Default
name	str	The UC Service name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_uc_service

add_uc_service(uc_service_data: UcService) -> Dict[str, Any]

Add a new UC Service.

Parameters:

Name	Type	Description	Default
uc_service_data	UcService	A dict describing the UC service.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If the service already exists.
AXLError	On other AXL faults.

update_uc_service

update_uc_service(**ucs_data: Unpack[UpdateUcService]) -> Dict[str, Any]

Update an existing UC Service.

Parameters:

Name	Type	Description	Default
**ucs_data	Unpack[UpdateUcService]	Keyword arguments for updateUcService. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_uc_service

remove_uc_service(name: str) -> Dict[str, Any]

Remove a UC Service by name.

Parameters:

Name	Type	Description	Default
name	str	The UC Service name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_announcement

get_announcement(name: str) -> Dict[str, Any]

Retrieve an Announcement by name.

Parameters:

Name	Type	Description	Default
name	str	The Announcement name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_announcement

add_announcement(announcement_data: Announcement) -> Dict[str, Any]

Add a new Announcement.

Parameters:

Name	Type	Description	Default
announcement_data	Announcement	A dict describing the announcement.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLDuplicateError	If the announcement already exists.
AXLError	On other AXL faults.

remove_announcement

remove_announcement(name: str) -> Dict[str, Any]

Remove an Announcement by name.

Parameters:

Name	Type	Description	Default
name	str	The Announcement name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_remote_destination_profile

get_remote_destination_profile(name: str) -> Dict[str, Any]

Retrieve a Remote Destination Profile by name.

Parameters:

Name	Type	Description	Default
name	str	The Remote Destination Profile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_remote_destination_profile

add_remote_destination_profile(rdp_data: RemoteDestinationProfile, line_data: Optional[List[Dict[str, Any]]] = None) -> Dict[str, Any]

Add a new Remote Destination Profile.

Parameters:

Name	Type	Description	Default
rdp_data	RemoteDestinationProfile	A dict describing the profile.	required
line_data	Optional[List[Dict[str, Any]]]	Optional list of line association dicts.	None

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_remote_destination_profile

update_remote_destination_profile(**rdp_data: Unpack[UpdateRemoteDestinationProfile]) -> Dict[str, Any]

Update an existing Remote Destination Profile.

Parameters:

Name	Type	Description	Default
**rdp_data	Unpack[UpdateRemoteDestinationProfile]	Keyword arguments for updateRemoteDestinationProfile. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_remote_destination_profile

remove_remote_destination_profile(name: str) -> Dict[str, Any]

Remove a Remote Destination Profile by name.

Parameters:

Name	Type	Description	Default
name	str	The Remote Destination Profile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_aar_group

get_aar_group(name: str) -> Dict[str, Any]

Retrieve a AarGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The AarGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_aar_group

add_aar_group(aar_group_data: AarGroup) -> Dict[str, Any]

Add a new AarGroup.

Parameters:

Name	Type	Description	Default
aar_group_data	AarGroup	A dict describing the AarGroup.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_aar_group

update_aar_group(**kwargs: Unpack[UpdateAarGroup]) -> Dict[str, Any]

Update an existing AarGroup.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateAarGroup]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_aar_group

remove_aar_group(name: str) -> Dict[str, Any]

Remove a AarGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The AarGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_aar_group

list_aar_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List AarGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_advertised_patterns

get_advertised_patterns(name: str) -> Dict[str, Any]

Retrieve a AdvertisedPatterns by name.

Parameters:

Name	Type	Description	Default
name	str	The AdvertisedPatterns name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_advertised_patterns

add_advertised_patterns(advertised_patterns_data: AdvertisedPatterns) -> Dict[str, Any]

Add a new AdvertisedPatterns.

Parameters:

Name	Type	Description	Default
advertised_patterns_data	AdvertisedPatterns	A dict describing the AdvertisedPatterns.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_advertised_patterns

update_advertised_patterns(**kwargs: Unpack[UpdateAdvertisedPatterns]) -> Dict[str, Any]

Update an existing AdvertisedPatterns.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateAdvertisedPatterns]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_advertised_patterns

remove_advertised_patterns(name: str) -> Dict[str, Any]

Remove a AdvertisedPatterns by name.

Parameters:

Name	Type	Description	Default
name	str	The AdvertisedPatterns name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_advertised_patterns

list_advertised_patterns(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List AdvertisedPatterns objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_announcement

update_announcement(**kwargs: Unpack[UpdateAnnouncement]) -> Dict[str, Any]

Update an existing Announcement.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateAnnouncement]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_announcement

list_announcement(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List Announcement objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_app_server_info

get_app_server_info(**kwargs) -> Dict[str, Any]

Retrieve an AppServerInfo.

Parameters:

Name	Type	Description	Default
**kwargs		Must include uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_app_server_info

add_app_server_info(app_server_info_data: AppServerInfo) -> Dict[str, Any]

Add a new AppServerInfo.

Parameters:

Name	Type	Description	Default
app_server_info_data	AppServerInfo	A dict describing the AppServerInfo.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_app_server_info

update_app_server_info(**kwargs: Unpack[UpdateAppServerInfo]) -> Dict[str, Any]

Update an existing AppServerInfo.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateAppServerInfo]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_app_server_info

remove_app_server_info(**kwargs) -> Dict[str, Any]

Remove an AppServerInfo.

Parameters:

Name	Type	Description	Default
**kwargs		Must include uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_app_user

list_app_user(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List AppUser objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_application_dial_rules

get_application_dial_rules(name: str) -> Dict[str, Any]

Retrieve a ApplicationDialRules by name.

Parameters:

Name	Type	Description	Default
name	str	The ApplicationDialRules name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_application_dial_rules

add_application_dial_rules(application_dial_rules_data: ApplicationDialRules) -> Dict[str, Any]

Add a new ApplicationDialRules.

Parameters:

Name	Type	Description	Default
application_dial_rules_data	ApplicationDialRules	A dict describing the ApplicationDialRules.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_application_dial_rules

update_application_dial_rules(**kwargs: Unpack[UpdateApplicationDialRules]) -> Dict[str, Any]

Update an existing ApplicationDialRules.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateApplicationDialRules]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_application_dial_rules

remove_application_dial_rules(name: str) -> Dict[str, Any]

Remove a ApplicationDialRules by name.

Parameters:

Name	Type	Description	Default
name	str	The ApplicationDialRules name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_application_dial_rules

list_application_dial_rules(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ApplicationDialRules objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_application_server

get_application_server(uuid: str) -> Dict[str, Any]

Retrieve an ApplicationServer by UUID.

Parameters:

Name	Type	Description	Default
uuid	str	The ApplicationServer UUID.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_application_server

add_application_server(application_server_data: ApplicationServer) -> Dict[str, Any]

Add a new ApplicationServer.

Parameters:

Name	Type	Description	Default
application_server_data	ApplicationServer	A dict describing the ApplicationServer.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_application_server

update_application_server(**kwargs: Unpack[UpdateApplicationServer]) -> Dict[str, Any]

Update an existing ApplicationServer.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateApplicationServer]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_application_server

remove_application_server(uuid: str) -> Dict[str, Any]

Remove an ApplicationServer by UUID.

Parameters:

Name	Type	Description	Default
uuid	str	The ApplicationServer UUID.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_application_server

list_application_server(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ApplicationServer objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

add_application_to_softkey_template

add_application_to_softkey_template(application_to_softkey_template_data: ApplicationToSoftKeyTemplate) -> Dict[str, Any]

Add a new ApplicationToSoftkeyTemplate.

Parameters:

Name	Type	Description	Default
application_to_softkey_template_data	ApplicationToSoftKeyTemplate	A dict describing the ApplicationToSoftkeyTemplate.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

remove_application_to_softkey_template

remove_application_to_softkey_template(name: str) -> Dict[str, Any]

Remove a ApplicationToSoftkeyTemplate by name.

Parameters:

Name	Type	Description	Default
name	str	The ApplicationToSoftkeyTemplate name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_application_user_capf_profile

get_application_user_capf_profile(instance_id: str) -> Dict[str, Any]

Retrieve an ApplicationUserCapfProfile by instanceId.

Parameters:

Name	Type	Description	Default
instance_id	str	The ApplicationUserCapfProfile instanceId.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_application_user_capf_profile

add_application_user_capf_profile(application_user_capf_profile_data: ApplicationUserCapfProfile) -> Dict[str, Any]

Add a new ApplicationUserCapfProfile.

Parameters:

Name	Type	Description	Default
application_user_capf_profile_data	ApplicationUserCapfProfile	A dict describing the ApplicationUserCapfProfile.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_application_user_capf_profile

update_application_user_capf_profile(**kwargs: Unpack[UpdateApplicationUserCapfProfile]) -> Dict[str, Any]

Update an existing ApplicationUserCapfProfile.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateApplicationUserCapfProfile]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_application_user_capf_profile

remove_application_user_capf_profile(instance_id: str) -> Dict[str, Any]

Remove an ApplicationUserCapfProfile by instanceId.

Parameters:

Name	Type	Description	Default
instance_id	str	The ApplicationUserCapfProfile instanceId.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_application_user_capf_profile

list_application_user_capf_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ApplicationUserCapfProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_assigned_presence_servers

list_assigned_presence_servers(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List AssignedPresenceServers objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_assigned_presence_users

list_assigned_presence_users(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List AssignedPresenceUsers objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_audio_codec_preference_list

get_audio_codec_preference_list(name: str) -> Dict[str, Any]

Retrieve a AudioCodecPreferenceList by name.

Parameters:

Name	Type	Description	Default
name	str	The AudioCodecPreferenceList name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_audio_codec_preference_list

add_audio_codec_preference_list(audio_codec_preference_list_data: AudioCodecPreferenceList) -> Dict[str, Any]

Add a new AudioCodecPreferenceList.

Parameters:

Name	Type	Description	Default
audio_codec_preference_list_data	AudioCodecPreferenceList	A dict describing the AudioCodecPreferenceList.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_audio_codec_preference_list

update_audio_codec_preference_list(**kwargs: Unpack[UpdateAudioCodecPreferenceList]) -> Dict[str, Any]

Update an existing AudioCodecPreferenceList.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateAudioCodecPreferenceList]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_audio_codec_preference_list

remove_audio_codec_preference_list(name: str) -> Dict[str, Any]

Remove a AudioCodecPreferenceList by name.

Parameters:

Name	Type	Description	Default
name	str	The AudioCodecPreferenceList name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_audio_codec_preference_list

list_audio_codec_preference_list(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List AudioCodecPreferenceList objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_billing_server

get_billing_server(name: str) -> Dict[str, Any]

Retrieve a BillingServer by name.

Parameters:

Name	Type	Description	Default
name	str	The BillingServer name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_billing_server

add_billing_server(billing_server_data: BillingServer) -> Dict[str, Any]

Add a new BillingServer.

Parameters:

Name	Type	Description	Default
billing_server_data	BillingServer	A dict describing the BillingServer.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_billing_server

update_billing_server(**kwargs: Unpack[UpdateBillingServer]) -> Dict[str, Any]

Update an existing BillingServer.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateBillingServer]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_billing_server

remove_billing_server(name: str) -> Dict[str, Any]

Remove a BillingServer by name.

Parameters:

Name	Type	Description	Default
name	str	The BillingServer name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_billing_server

list_billing_server(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List BillingServer objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_blocked_learned_patterns

get_blocked_learned_patterns(name: str) -> Dict[str, Any]

Retrieve a BlockedLearnedPatterns by name.

Parameters:

Name	Type	Description	Default
name	str	The BlockedLearnedPatterns name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_blocked_learned_patterns

add_blocked_learned_patterns(blocked_learned_patterns_data: BlockedLearnedPatterns) -> Dict[str, Any]

Add a new BlockedLearnedPatterns.

Parameters:

Name	Type	Description	Default
blocked_learned_patterns_data	BlockedLearnedPatterns	A dict describing the BlockedLearnedPatterns.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_blocked_learned_patterns

update_blocked_learned_patterns(**kwargs: Unpack[UpdateBlockedLearnedPatterns]) -> Dict[str, Any]

Update an existing BlockedLearnedPatterns.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateBlockedLearnedPatterns]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_blocked_learned_patterns

remove_blocked_learned_patterns(name: str) -> Dict[str, Any]

Remove a BlockedLearnedPatterns by name.

Parameters:

Name	Type	Description	Default
name	str	The BlockedLearnedPatterns name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_blocked_learned_patterns

list_blocked_learned_patterns(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List BlockedLearnedPatterns objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_cca_profiles

get_cca_profiles(cca_id: str = '', **kwargs) -> Dict[str, Any]

Retrieve a CCAProfiles by ccaId.

Parameters:

Name	Type	Description	Default
cca_id	str	The CCA ID.	''
**kwargs		Additional fields (e.g. uuid, returnedTags).	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_cca_profiles

add_cca_profiles(cca_profiles_data: CCAProfiles) -> Dict[str, Any]

Add a new CCAProfiles.

Parameters:

Name	Type	Description	Default
cca_profiles_data	CCAProfiles	A dict describing the CCAProfiles.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_cca_profiles

update_cca_profiles(**kwargs: Unpack[UpdateCCAProfiles]) -> Dict[str, Any]

Update an existing CCAProfiles.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCCAProfiles]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_cca_profiles

remove_cca_profiles(cca_id: str = '', **kwargs) -> Dict[str, Any]

Remove a CCAProfiles by ccaId.

Parameters:

Name	Type	Description	Default
cca_id	str	The CCA ID.	''
**kwargs		Additional fields (e.g. uuid).	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_cca_profiles

list_cca_profiles(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CCAProfiles objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ccm_version

get_ccm_version(name: str = '') -> Dict[str, Any]

Retrieve the CCM (Unified CM) version.

Parameters:

Name	Type	Description	Default
name	str	Optional process node name. Pass "" (the default) to retrieve the version from the publisher.	''

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict. The version string is at
Dict[str, Any]	result["return"]["componentVersion"]["version"].

Raises:

Type	Description
AXLError	On AXL faults.

list_call_manager_group

list_call_manager_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CallManagerGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_call_manager_group

apply_call_manager_group(name: str) -> Dict[str, Any]

Apply configuration for a CallManagerGroup.

Parameters:

Name	Type	Description	Default
name	str	The CallManagerGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_call_manager_group

reset_call_manager_group(name: str) -> Dict[str, Any]

Reset a CallManagerGroup.

Parameters:

Name	Type	Description	Default
name	str	The CallManagerGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_call_park

update_call_park(**kwargs: Unpack[UpdateCallPark]) -> Dict[str, Any]

Update an existing CallPark.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCallPark]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_call_park

list_call_park(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CallPark objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_call_pickup_group

list_call_pickup_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CallPickupGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

add_called_party_tracing

add_called_party_tracing(called_party_tracing_data: CalledPartyTracing) -> Dict[str, Any]

Add a new CalledPartyTracing.

Parameters:

Name	Type	Description	Default
called_party_tracing_data	CalledPartyTracing	A dict describing the CalledPartyTracing.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

remove_called_party_tracing

remove_called_party_tracing(directorynumber: str) -> Dict[str, Any]

Remove a CalledPartyTracing by directory number.

Parameters:

Name	Type	Description	Default
directorynumber	str	The CalledPartyTracing directory number.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_called_party_tracing

list_called_party_tracing(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CalledPartyTracing objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_called_party_transformation_pattern

update_called_party_transformation_pattern(**kwargs: Unpack[UpdateCalledPartyTransformationPattern]) -> Dict[str, Any]

Update an existing CalledPartyTransformationPattern.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCalledPartyTransformationPattern]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_called_party_transformation_pattern

list_called_party_transformation_pattern(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CalledPartyTransformationPattern objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_caller_filter_list

get_caller_filter_list(name: str) -> Dict[str, Any]

Retrieve a CallerFilterList by name.

Parameters:

Name	Type	Description	Default
name	str	The CallerFilterList name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_caller_filter_list

add_caller_filter_list(caller_filter_list_data: CallerFilterList) -> Dict[str, Any]

Add a new CallerFilterList.

Parameters:

Name	Type	Description	Default
caller_filter_list_data	CallerFilterList	A dict describing the CallerFilterList.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_caller_filter_list

update_caller_filter_list(**kwargs: Unpack[UpdateCallerFilterList]) -> Dict[str, Any]

Update an existing CallerFilterList.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCallerFilterList]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_caller_filter_list

remove_caller_filter_list(name: str) -> Dict[str, Any]

Remove a CallerFilterList by name.

Parameters:

Name	Type	Description	Default
name	str	The CallerFilterList name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_caller_filter_list

list_caller_filter_list(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CallerFilterList objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_calling_party_transformation_pattern

update_calling_party_transformation_pattern(**kwargs: Unpack[UpdateCallingPartyTransformationPattern]) -> Dict[str, Any]

Update an existing CallingPartyTransformationPattern.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCallingPartyTransformationPattern]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_calling_party_transformation_pattern

list_calling_party_transformation_pattern(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CallingPartyTransformationPattern objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ccd_advertising_service

get_ccd_advertising_service(name: str) -> Dict[str, Any]

Retrieve a CcdAdvertisingService by name.

Parameters:

Name	Type	Description	Default
name	str	The CcdAdvertisingService name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_ccd_advertising_service

add_ccd_advertising_service(ccd_advertising_service_data: CcdAdvertisingService) -> Dict[str, Any]

Add a new CcdAdvertisingService.

Parameters:

Name	Type	Description	Default
ccd_advertising_service_data	CcdAdvertisingService	A dict describing the CcdAdvertisingService.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ccd_advertising_service

update_ccd_advertising_service(**kwargs: Unpack[UpdateCcdAdvertisingService]) -> Dict[str, Any]

Update an existing CcdAdvertisingService.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCcdAdvertisingService]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_ccd_advertising_service

remove_ccd_advertising_service(name: str) -> Dict[str, Any]

Remove a CcdAdvertisingService by name.

Parameters:

Name	Type	Description	Default
name	str	The CcdAdvertisingService name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ccd_advertising_service

list_ccd_advertising_service(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CcdAdvertisingService objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ccd_hosted_dn

get_ccd_hosted_dn(hosted_pattern: str) -> Dict[str, Any]

Retrieve a CcdHostedDN by hostedPattern.

Parameters:

Name	Type	Description	Default
hosted_pattern	str	The CcdHostedDN hostedPattern.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_ccd_hosted_dn

add_ccd_hosted_dn(ccd_hosted_dn_data: CcdHostedDN) -> Dict[str, Any]

Add a new CcdHostedDN.

Parameters:

Name	Type	Description	Default
ccd_hosted_dn_data	CcdHostedDN	A dict describing the CcdHostedDN.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ccd_hosted_dn

update_ccd_hosted_dn(**kwargs: Unpack[UpdateCcdHostedDN]) -> Dict[str, Any]

Update an existing CcdHostedDN.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCcdHostedDN]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_ccd_hosted_dn

remove_ccd_hosted_dn(hosted_pattern: str) -> Dict[str, Any]

Remove a CcdHostedDN by hostedPattern.

Parameters:

Name	Type	Description	Default
hosted_pattern	str	The CcdHostedDN hostedPattern.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ccd_hosted_dn

list_ccd_hosted_dn(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CcdHostedDN objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ccd_hosted_dn_group

get_ccd_hosted_dn_group(name: str) -> Dict[str, Any]

Retrieve a CcdHostedDNGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The CcdHostedDNGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_ccd_hosted_dn_group

add_ccd_hosted_dn_group(ccd_hosted_dn_group_data: CcdHostedDNGroup) -> Dict[str, Any]

Add a new CcdHostedDNGroup.

Parameters:

Name	Type	Description	Default
ccd_hosted_dn_group_data	CcdHostedDNGroup	A dict describing the CcdHostedDNGroup.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ccd_hosted_dn_group

update_ccd_hosted_dn_group(**kwargs: Unpack[UpdateCcdHostedDNGroup]) -> Dict[str, Any]

Update an existing CcdHostedDNGroup.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCcdHostedDNGroup]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_ccd_hosted_dn_group

remove_ccd_hosted_dn_group(name: str) -> Dict[str, Any]

Remove a CcdHostedDNGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The CcdHostedDNGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ccd_hosted_dn_group

list_ccd_hosted_dn_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CcdHostedDNGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ccd_requesting_service

get_ccd_requesting_service(name: str) -> Dict[str, Any]

Retrieve a CcdRequestingService by name.

Parameters:

Name	Type	Description	Default
name	str	The CcdRequestingService name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_ccd_requesting_service

add_ccd_requesting_service(ccd_requesting_service_data: CcdRequestingService) -> Dict[str, Any]

Add a new CcdRequestingService.

Parameters:

Name	Type	Description	Default
ccd_requesting_service_data	CcdRequestingService	A dict describing the CcdRequestingService.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ccd_requesting_service

update_ccd_requesting_service(**kwargs: Unpack[UpdateCcdRequestingService]) -> Dict[str, Any]

Update an existing CcdRequestingService.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCcdRequestingService]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_ccd_requesting_service

remove_ccd_requesting_service(name: str) -> Dict[str, Any]

Remove a CcdRequestingService by name.

Parameters:

Name	Type	Description	Default
name	str	The CcdRequestingService name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_change

list_change(**kwargs) -> Dict[str, Any]

List changes since a given change ID.

Parameters:

Name	Type	Description	Default
**kwargs		Keyword arguments passed to the WSDL operation. Typically startChangeId and optionally objectList.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_cisco_catalyst600024_port_fxs_gateway

get_cisco_catalyst600024_port_fxs_gateway(name: str) -> Dict[str, Any]

Retrieve a CiscoCatalyst600024PortFXSGateway by name.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst600024PortFXSGateway name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_cisco_catalyst600024_port_fxs_gateway

add_cisco_catalyst600024_port_fxs_gateway(cisco_catalyst600024_port_fxs_gateway_data: CiscoCatalyst600024PortFXSGateway) -> Dict[str, Any]

Add a new CiscoCatalyst600024PortFXSGateway.

Parameters:

Name	Type	Description	Default
cisco_catalyst600024_port_fxs_gateway_data	CiscoCatalyst600024PortFXSGateway	A dict describing the CiscoCatalyst600024PortFXSGateway.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_cisco_catalyst600024_port_fxs_gateway

update_cisco_catalyst600024_port_fxs_gateway(**kwargs: Unpack[UpdateCiscoCatalyst600024PortFXSGateway]) -> Dict[str, Any]

Update an existing CiscoCatalyst600024PortFXSGateway.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCiscoCatalyst600024PortFXSGateway]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_cisco_catalyst600024_port_fxs_gateway

remove_cisco_catalyst600024_port_fxs_gateway(name: str) -> Dict[str, Any]

Remove a CiscoCatalyst600024PortFXSGateway by name.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst600024PortFXSGateway name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_cisco_catalyst600024_port_fxs_gateway

list_cisco_catalyst600024_port_fxs_gateway(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CiscoCatalyst600024PortFXSGateway objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_cisco_catalyst600024_port_fxs_gateway

apply_cisco_catalyst600024_port_fxs_gateway(name: str) -> Dict[str, Any]

Apply configuration for a CiscoCatalyst600024PortFXSGateway.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst600024PortFXSGateway name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_cisco_catalyst600024_port_fxs_gateway

reset_cisco_catalyst600024_port_fxs_gateway(name: str) -> Dict[str, Any]

Reset a CiscoCatalyst600024PortFXSGateway.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst600024PortFXSGateway name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_cisco_catalyst600024_port_fxs_gateway

restart_cisco_catalyst600024_port_fxs_gateway(name: str) -> Dict[str, Any]

Restart a CiscoCatalyst600024PortFXSGateway.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst600024PortFXSGateway name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_cisco_catalyst6000_e1_vo_ip_gateway

get_cisco_catalyst6000_e1_vo_ip_gateway(name: str) -> Dict[str, Any]

Retrieve a CiscoCatalyst6000E1VoIPGateway by name.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst6000E1VoIPGateway name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_cisco_catalyst6000_e1_vo_ip_gateway

add_cisco_catalyst6000_e1_vo_ip_gateway(cisco_catalyst6000_e1_vo_ip_gateway_data: CiscoCatalyst6000E1VoIPGateway) -> Dict[str, Any]

Add a new CiscoCatalyst6000E1VoIPGateway.

Parameters:

Name	Type	Description	Default
cisco_catalyst6000_e1_vo_ip_gateway_data	CiscoCatalyst6000E1VoIPGateway	A dict describing the CiscoCatalyst6000E1VoIPGateway.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_cisco_catalyst6000_e1_vo_ip_gateway

update_cisco_catalyst6000_e1_vo_ip_gateway(**kwargs: Unpack[UpdateCiscoCatalyst6000E1VoIPGateway]) -> Dict[str, Any]

Update an existing CiscoCatalyst6000E1VoIPGateway.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCiscoCatalyst6000E1VoIPGateway]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_cisco_catalyst6000_e1_vo_ip_gateway

remove_cisco_catalyst6000_e1_vo_ip_gateway(name: str) -> Dict[str, Any]

Remove a CiscoCatalyst6000E1VoIPGateway by name.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst6000E1VoIPGateway name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_cisco_catalyst6000_e1_vo_ip_gateway

list_cisco_catalyst6000_e1_vo_ip_gateway(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CiscoCatalyst6000E1VoIPGateway objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_cisco_catalyst6000_e1_vo_ip_gateway

apply_cisco_catalyst6000_e1_vo_ip_gateway(name: str) -> Dict[str, Any]

Apply configuration for a CiscoCatalyst6000E1VoIPGateway.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst6000E1VoIPGateway name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_cisco_catalyst6000_e1_vo_ip_gateway

reset_cisco_catalyst6000_e1_vo_ip_gateway(name: str) -> Dict[str, Any]

Reset a CiscoCatalyst6000E1VoIPGateway.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst6000E1VoIPGateway name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_cisco_catalyst6000_e1_vo_ip_gateway

restart_cisco_catalyst6000_e1_vo_ip_gateway(name: str) -> Dict[str, Any]

Restart a CiscoCatalyst6000E1VoIPGateway.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst6000E1VoIPGateway name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_cisco_catalyst6000_t1_vo_ip_gateway_pri

get_cisco_catalyst6000_t1_vo_ip_gateway_pri(name: str) -> Dict[str, Any]

Retrieve a CiscoCatalyst6000T1VoIPGatewayPri by name.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst6000T1VoIPGatewayPri name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_cisco_catalyst6000_t1_vo_ip_gateway_pri

add_cisco_catalyst6000_t1_vo_ip_gateway_pri(cisco_catalyst6000_t1_vo_ip_gateway_pri_data: CiscoCatalyst6000T1VoIPGatewayPri) -> Dict[str, Any]

Add a new CiscoCatalyst6000T1VoIPGatewayPri.

Parameters:

Name	Type	Description	Default
cisco_catalyst6000_t1_vo_ip_gateway_pri_data	CiscoCatalyst6000T1VoIPGatewayPri	A dict describing the CiscoCatalyst6000T1VoIPGatewayPri.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_cisco_catalyst6000_t1_vo_ip_gateway_pri

update_cisco_catalyst6000_t1_vo_ip_gateway_pri(**kwargs: Unpack[UpdateCiscoCatalyst6000T1VoIPGatewayPri]) -> Dict[str, Any]

Update an existing CiscoCatalyst6000T1VoIPGatewayPri.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCiscoCatalyst6000T1VoIPGatewayPri]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_cisco_catalyst6000_t1_vo_ip_gateway_pri

remove_cisco_catalyst6000_t1_vo_ip_gateway_pri(name: str) -> Dict[str, Any]

Remove a CiscoCatalyst6000T1VoIPGatewayPri by name.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst6000T1VoIPGatewayPri name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_cisco_catalyst6000_t1_vo_ip_gateway_pri

list_cisco_catalyst6000_t1_vo_ip_gateway_pri(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CiscoCatalyst6000T1VoIPGatewayPri objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_cisco_catalyst6000_t1_vo_ip_gateway_pri

apply_cisco_catalyst6000_t1_vo_ip_gateway_pri(name: str) -> Dict[str, Any]

Apply configuration for a CiscoCatalyst6000T1VoIPGatewayPri.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst6000T1VoIPGatewayPri name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_cisco_catalyst6000_t1_vo_ip_gateway_pri

reset_cisco_catalyst6000_t1_vo_ip_gateway_pri(name: str) -> Dict[str, Any]

Reset a CiscoCatalyst6000T1VoIPGatewayPri.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst6000T1VoIPGatewayPri name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_cisco_catalyst6000_t1_vo_ip_gateway_pri

restart_cisco_catalyst6000_t1_vo_ip_gateway_pri(name: str) -> Dict[str, Any]

Restart a CiscoCatalyst6000T1VoIPGatewayPri.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst6000T1VoIPGatewayPri name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_cisco_catalyst6000_t1_vo_ip_gateway_t1

get_cisco_catalyst6000_t1_vo_ip_gateway_t1(name: str) -> Dict[str, Any]

Retrieve a CiscoCatalyst6000T1VoIPGatewayT1 by name.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst6000T1VoIPGatewayT1 name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_cisco_catalyst6000_t1_vo_ip_gateway_t1

add_cisco_catalyst6000_t1_vo_ip_gateway_t1(cisco_catalyst6000_t1_vo_ip_gateway_t1_data: CiscoCatalyst6000T1VoIPGatewayT1) -> Dict[str, Any]

Add a new CiscoCatalyst6000T1VoIPGatewayT1.

Parameters:

Name	Type	Description	Default
cisco_catalyst6000_t1_vo_ip_gateway_t1_data	CiscoCatalyst6000T1VoIPGatewayT1	A dict describing the CiscoCatalyst6000T1VoIPGatewayT1.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_cisco_catalyst6000_t1_vo_ip_gateway_t1

update_cisco_catalyst6000_t1_vo_ip_gateway_t1(**kwargs: Unpack[UpdateCiscoCatalyst6000T1VoIPGatewayT1]) -> Dict[str, Any]

Update an existing CiscoCatalyst6000T1VoIPGatewayT1.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCiscoCatalyst6000T1VoIPGatewayT1]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_cisco_catalyst6000_t1_vo_ip_gateway_t1

remove_cisco_catalyst6000_t1_vo_ip_gateway_t1(name: str) -> Dict[str, Any]

Remove a CiscoCatalyst6000T1VoIPGatewayT1 by name.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst6000T1VoIPGatewayT1 name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_cisco_catalyst6000_t1_vo_ip_gateway_t1

list_cisco_catalyst6000_t1_vo_ip_gateway_t1(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CiscoCatalyst6000T1VoIPGatewayT1 objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_cisco_catalyst6000_t1_vo_ip_gateway_t1

apply_cisco_catalyst6000_t1_vo_ip_gateway_t1(name: str) -> Dict[str, Any]

Apply configuration for a CiscoCatalyst6000T1VoIPGatewayT1.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst6000T1VoIPGatewayT1 name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_cisco_catalyst6000_t1_vo_ip_gateway_t1

reset_cisco_catalyst6000_t1_vo_ip_gateway_t1(name: str) -> Dict[str, Any]

Reset a CiscoCatalyst6000T1VoIPGatewayT1.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst6000T1VoIPGatewayT1 name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_cisco_catalyst6000_t1_vo_ip_gateway_t1

restart_cisco_catalyst6000_t1_vo_ip_gateway_t1(name: str) -> Dict[str, Any]

Restart a CiscoCatalyst6000T1VoIPGatewayT1.

Parameters:

Name	Type	Description	Default
name	str	The CiscoCatalyst6000T1VoIPGatewayT1 name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_cmc_info

get_cmc_info(name: str) -> Dict[str, Any]

Retrieve a CmcInfo by name.

Parameters:

Name	Type	Description	Default
name	str	The CmcInfo name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_cmc_info

add_cmc_info(cmc_info_data: CmcInfo) -> Dict[str, Any]

Add a new CmcInfo.

Parameters:

Name	Type	Description	Default
cmc_info_data	CmcInfo	A dict describing the CmcInfo.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_cmc_info

update_cmc_info(**kwargs: Unpack[UpdateCmcInfo]) -> Dict[str, Any]

Update an existing CmcInfo.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCmcInfo]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_cmc_info

remove_cmc_info(name: str) -> Dict[str, Any]

Remove a CmcInfo by name.

Parameters:

Name	Type	Description	Default
name	str	The CmcInfo name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_cmc_info

list_cmc_info(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CmcInfo objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_common_device_config

list_common_device_config(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CommonDeviceConfig objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_common_device_config

apply_common_device_config(name: str) -> Dict[str, Any]

Apply configuration for a CommonDeviceConfig.

Parameters:

Name	Type	Description	Default
name	str	The CommonDeviceConfig name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_common_device_config

reset_common_device_config(name: str) -> Dict[str, Any]

Reset a CommonDeviceConfig.

Parameters:

Name	Type	Description	Default
name	str	The CommonDeviceConfig name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_common_phone_config

list_common_phone_config(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CommonPhoneConfig objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_common_phone_config

apply_common_phone_config(name: str) -> Dict[str, Any]

Apply configuration for a CommonPhoneConfig.

Parameters:

Name	Type	Description	Default
name	str	The CommonPhoneConfig name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_common_phone_config

reset_common_phone_config(name: str) -> Dict[str, Any]

Reset a CommonPhoneConfig.

Parameters:

Name	Type	Description	Default
name	str	The CommonPhoneConfig name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_conference_bridge

list_conference_bridge(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ConferenceBridge objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_conference_bridge

apply_conference_bridge(name: str) -> Dict[str, Any]

Apply configuration for a ConferenceBridge.

Parameters:

Name	Type	Description	Default
name	str	The ConferenceBridge name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_conference_bridge

reset_conference_bridge(name: str) -> Dict[str, Any]

Reset a ConferenceBridge.

Parameters:

Name	Type	Description	Default
name	str	The ConferenceBridge name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_conference_bridge

restart_conference_bridge(name: str) -> Dict[str, Any]

Restart a ConferenceBridge.

Parameters:

Name	Type	Description	Default
name	str	The ConferenceBridge name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_conference_now

get_conference_now(conferenceNowNumber: str) -> Dict[str, Any]

Retrieve a ConferenceNow by conference number.

Parameters:

Name	Type	Description	Default
conferenceNowNumber	str	The ConferenceNow number.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_conference_now

add_conference_now(conference_now_data: ConferenceNow) -> Dict[str, Any]

Add a new ConferenceNow.

Parameters:

Name	Type	Description	Default
conference_now_data	ConferenceNow	A dict describing the ConferenceNow.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_conference_now

update_conference_now(**kwargs: Unpack[UpdateConferenceNow]) -> Dict[str, Any]

Update an existing ConferenceNow.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateConferenceNow]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_conference_now

remove_conference_now(conferenceNowNumber: str) -> Dict[str, Any]

Remove a ConferenceNow by conference number.

Parameters:

Name	Type	Description	Default
conferenceNowNumber	str	The ConferenceNow number.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_conference_now

list_conference_now(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ConferenceNow objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_config_enterprise_parameters

apply_config_enterprise_parameters() -> Dict[str, Any]

Apply configuration for enterprise parameters.

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

add_credential_policy

add_credential_policy(credential_policy_data: CredentialPolicy) -> Dict[str, Any]

Add a new CredentialPolicy.

Parameters:

Name	Type	Description	Default
credential_policy_data	CredentialPolicy	A dict describing the CredentialPolicy.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

remove_credential_policy

remove_credential_policy(name: str) -> Dict[str, Any]

Remove a CredentialPolicy by name.

Parameters:

Name	Type	Description	Default
name	str	The CredentialPolicy name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_credential_policy

list_credential_policy(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CredentialPolicy objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_css

list_css(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List Css objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_cti_route_point

list_cti_route_point(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CtiRoutePoint objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_cti_route_point

apply_cti_route_point(name: str) -> Dict[str, Any]

Apply configuration for a CtiRoutePoint.

Parameters:

Name	Type	Description	Default
name	str	The CtiRoutePoint name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_cti_route_point

reset_cti_route_point(name: str) -> Dict[str, Any]

Reset a CtiRoutePoint.

Parameters:

Name	Type	Description	Default
name	str	The CtiRoutePoint name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_cti_route_point

restart_cti_route_point(name: str) -> Dict[str, Any]

Restart a CtiRoutePoint.

Parameters:

Name	Type	Description	Default
name	str	The CtiRoutePoint name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_cuma_server_security_profile

get_cuma_server_security_profile(name: str) -> Dict[str, Any]

Retrieve a CumaServerSecurityProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The CumaServerSecurityProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_cuma_server_security_profile

add_cuma_server_security_profile(cuma_server_security_profile_data: CumaServerSecurityProfile) -> Dict[str, Any]

Add a new CumaServerSecurityProfile.

Parameters:

Name	Type	Description	Default
cuma_server_security_profile_data	CumaServerSecurityProfile	A dict describing the CumaServerSecurityProfile.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_cuma_server_security_profile

update_cuma_server_security_profile(**kwargs: Unpack[UpdateCumaServerSecurityProfile]) -> Dict[str, Any]

Update an existing CumaServerSecurityProfile.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCumaServerSecurityProfile]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_cuma_server_security_profile

remove_cuma_server_security_profile(name: str) -> Dict[str, Any]

Remove a CumaServerSecurityProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The CumaServerSecurityProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_cuma_server_security_profile

list_cuma_server_security_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CumaServerSecurityProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_custom_user_field

get_custom_user_field(field: str) -> Dict[str, Any]

Retrieve a CustomUserField by field name.

Parameters:

Name	Type	Description	Default
field	str	The CustomUserField field name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_custom_user_field

add_custom_user_field(custom_user_field_data: CustomUserField) -> Dict[str, Any]

Add a new CustomUserField.

Parameters:

Name	Type	Description	Default
custom_user_field_data	CustomUserField	A dict describing the CustomUserField.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_custom_user_field

update_custom_user_field(**kwargs: Unpack[UpdateCustomUserField]) -> Dict[str, Any]

Update an existing CustomUserField.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCustomUserField]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_custom_user_field

remove_custom_user_field(field: str) -> Dict[str, Any]

Remove a CustomUserField by field name.

Parameters:

Name	Type	Description	Default
field	str	The CustomUserField field name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_custom_user_field

list_custom_user_field(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CustomUserField objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_customer

get_customer(name: str) -> Dict[str, Any]

Retrieve a Customer by name.

Parameters:

Name	Type	Description	Default
name	str	The Customer name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_customer

add_customer(customer_data: Customer) -> Dict[str, Any]

Add a new Customer.

Parameters:

Name	Type	Description	Default
customer_data	Customer	A dict describing the Customer.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_customer

update_customer(**kwargs: Unpack[UpdateCustomer]) -> Dict[str, Any]

Update an existing Customer.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCustomer]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_customer

remove_customer(name: str) -> Dict[str, Any]

Remove a Customer by name.

Parameters:

Name	Type	Description	Default
name	str	The Customer name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_customer

list_customer(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List Customer objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_date_time_group

list_date_time_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List DateTimeGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_date_time_group

apply_date_time_group(name: str) -> Dict[str, Any]

Apply configuration for a DateTimeGroup.

Parameters:

Name	Type	Description	Default
name	str	The DateTimeGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_date_time_group

reset_date_time_group(name: str) -> Dict[str, Any]

Reset a DateTimeGroup.

Parameters:

Name	Type	Description	Default
name	str	The DateTimeGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ddi

get_ddi(**kwargs) -> Dict[str, Any]

Retrieve a Ddi.

Parameters:

Name	Type	Description	Default
**kwargs		Must include name + dialPlanName, or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ddi

list_ddi(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List Ddi objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_default_device_profile

get_default_device_profile(name: str) -> Dict[str, Any]

Retrieve a DefaultDeviceProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The DefaultDeviceProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_default_device_profile

add_default_device_profile(default_device_profile_data: DefaultDeviceProfile) -> Dict[str, Any]

Add a new DefaultDeviceProfile.

Parameters:

Name	Type	Description	Default
default_device_profile_data	DefaultDeviceProfile	A dict describing the DefaultDeviceProfile.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_default_device_profile

update_default_device_profile(**kwargs: Unpack[UpdateDefaultDeviceProfile]) -> Dict[str, Any]

Update an existing DefaultDeviceProfile.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateDefaultDeviceProfile]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_default_device_profile

remove_default_device_profile(name: str) -> Dict[str, Any]

Remove a DefaultDeviceProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The DefaultDeviceProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_default_device_profile

list_default_device_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List DefaultDeviceProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_device_mobility

get_device_mobility(name: str) -> Dict[str, Any]

Retrieve a DeviceMobility by name.

Parameters:

Name	Type	Description	Default
name	str	The DeviceMobility name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_device_mobility

add_device_mobility(device_mobility_data: DeviceMobility) -> Dict[str, Any]

Add a new DeviceMobility.

Parameters:

Name	Type	Description	Default
device_mobility_data	DeviceMobility	A dict describing the DeviceMobility.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_device_mobility

update_device_mobility(**kwargs: Unpack[UpdateDeviceMobility]) -> Dict[str, Any]

Update an existing DeviceMobility.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateDeviceMobility]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_device_mobility

remove_device_mobility(name: str) -> Dict[str, Any]

Remove a DeviceMobility by name.

Parameters:

Name	Type	Description	Default
name	str	The DeviceMobility name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_device_mobility

list_device_mobility(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List DeviceMobility objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_device_mobility_group

get_device_mobility_group(name: str) -> Dict[str, Any]

Retrieve a DeviceMobilityGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The DeviceMobilityGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_device_mobility_group

add_device_mobility_group(device_mobility_group_data: DeviceMobilityGroup) -> Dict[str, Any]

Add a new DeviceMobilityGroup.

Parameters:

Name	Type	Description	Default
device_mobility_group_data	DeviceMobilityGroup	A dict describing the DeviceMobilityGroup.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_device_mobility_group

update_device_mobility_group(**kwargs: Unpack[UpdateDeviceMobilityGroup]) -> Dict[str, Any]

Update an existing DeviceMobilityGroup.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateDeviceMobilityGroup]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_device_mobility_group

remove_device_mobility_group(name: str) -> Dict[str, Any]

Remove a DeviceMobilityGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The DeviceMobilityGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_device_mobility_group

list_device_mobility_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List DeviceMobilityGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_device_pool

list_device_pool(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List DevicePool objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_device_pool

apply_device_pool(name: str) -> Dict[str, Any]

Apply configuration for a DevicePool.

Parameters:

Name	Type	Description	Default
name	str	The DevicePool name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_device_pool

reset_device_pool(name: str) -> Dict[str, Any]

Reset a DevicePool.

Parameters:

Name	Type	Description	Default
name	str	The DevicePool name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_device_pool

restart_device_pool(name: str) -> Dict[str, Any]

Restart a DevicePool.

Parameters:

Name	Type	Description	Default
name	str	The DevicePool name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_device_profile

list_device_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List DeviceProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_device_profile_options

get_device_profile_options(uuid: str) -> Dict[str, Any]

Retrieve DeviceProfileOptions.

Parameters:

Name	Type	Description	Default
uuid	str	The UUID of the device profile.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_dhcp_server

get_dhcp_server(process_node_name: str) -> Dict[str, Any]

Retrieve a DhcpServer by process node name.

Parameters:

Name	Type	Description	Default
process_node_name	str	The process node name hosting the DHCP server.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_dhcp_server

add_dhcp_server(dhcp_server_data: DhcpServer) -> Dict[str, Any]

Add a new DhcpServer.

Parameters:

Name	Type	Description	Default
dhcp_server_data	DhcpServer	A dict describing the DhcpServer.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_dhcp_server

update_dhcp_server(**kwargs: Unpack[UpdateDhcpServer]) -> Dict[str, Any]

Update an existing DhcpServer.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateDhcpServer]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_dhcp_server

remove_dhcp_server(process_node_name: str) -> Dict[str, Any]

Remove a DhcpServer by process node name.

Parameters:

Name	Type	Description	Default
process_node_name	str	The process node name hosting the DHCP server.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_dhcp_server

list_dhcp_server(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List DhcpServer objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_dhcp_subnet

get_dhcp_subnet(dhcp_server_name: str, subnet_ip_address: str) -> Dict[str, Any]

Retrieve a DhcpSubnet by server name and subnet IP.

Parameters:

Name	Type	Description	Default
dhcp_server_name	str	The DHCP server (process node) name.	required
subnet_ip_address	str	The subnet IP address.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_dhcp_subnet

add_dhcp_subnet(dhcp_subnet_data: DhcpSubnet) -> Dict[str, Any]

Add a new DhcpSubnet.

Parameters:

Name	Type	Description	Default
dhcp_subnet_data	DhcpSubnet	A dict describing the DhcpSubnet.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_dhcp_subnet

update_dhcp_subnet(**kwargs: Unpack[UpdateDhcpSubnet]) -> Dict[str, Any]

Update an existing DhcpSubnet.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateDhcpSubnet]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_dhcp_subnet

remove_dhcp_subnet(dhcp_server_name: str, subnet_ip_address: str) -> Dict[str, Any]

Remove a DhcpSubnet by server name and subnet IP.

Parameters:

Name	Type	Description	Default
dhcp_server_name	str	The DHCP server (process node) name.	required
subnet_ip_address	str	The subnet IP address.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_dhcp_subnet

list_dhcp_subnet(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List DhcpSubnet objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_dial_plan

get_dial_plan(name: str) -> Dict[str, Any]

Retrieve a DialPlan by name.

Parameters:

Name	Type	Description	Default
name	str	The DialPlan name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_dial_plan

list_dial_plan(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List DialPlan objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_dial_plan_tag

get_dial_plan_tag(**kwargs) -> Dict[str, Any]

Retrieve a DialPlanTag.

Parameters:

Name	Type	Description	Default
**kwargs		Must include name + dialPlanName, or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_dial_plan_tag

list_dial_plan_tag(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List DialPlanTag objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_dir_number_alias_lookupand_sync

get_dir_number_alias_lookupand_sync(name: str) -> Dict[str, Any]

Retrieve a DirNumberAliasLookupandSync by name.

Parameters:

Name	Type	Description	Default
name	str	The DirNumberAliasLookupandSync name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_dir_number_alias_lookupand_sync

add_dir_number_alias_lookupand_sync(dir_number_alias_lookupand_sync_data: DirNumberAliasLookupandSync) -> Dict[str, Any]

Add a new DirNumberAliasLookupandSync.

Parameters:

Name	Type	Description	Default
dir_number_alias_lookupand_sync_data	DirNumberAliasLookupandSync	A dict describing the DirNumberAliasLookupandSync.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_dir_number_alias_lookupand_sync

update_dir_number_alias_lookupand_sync(**kwargs: Unpack[UpdateDirNumberAliasLookupandSync]) -> Dict[str, Any]

Update an existing DirNumberAliasLookupandSync.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateDirNumberAliasLookupandSync]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_dir_number_alias_lookupand_sync

remove_dir_number_alias_lookupand_sync(name: str) -> Dict[str, Any]

Remove a DirNumberAliasLookupandSync by name.

Parameters:

Name	Type	Description	Default
name	str	The DirNumberAliasLookupandSync name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_dir_number_alias_lookupand_sync

list_dir_number_alias_lookupand_sync(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List DirNumberAliasLookupandSync objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_directed_call_park

get_directed_call_park(pattern: str, route_partition_name: str = '') -> Dict[str, Any]

Retrieve a Directed Call Park by pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The directed call park pattern.	required
route_partition_name	str	The route partition (default "" for no partition).	''

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_directed_call_park

add_directed_call_park(directed_call_park_data: DirectedCallPark) -> Dict[str, Any]

Add a new DirectedCallPark.

Parameters:

Name	Type	Description	Default
directed_call_park_data	DirectedCallPark	A dict describing the DirectedCallPark.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_directed_call_park

update_directed_call_park(**kwargs: Unpack[UpdateDirectedCallPark]) -> Dict[str, Any]

Update an existing DirectedCallPark.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateDirectedCallPark]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_directed_call_park

remove_directed_call_park(pattern: str, route_partition_name: str = '') -> Dict[str, Any]

Remove a Directed Call Park by pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The directed call park pattern.	required
route_partition_name	str	The route partition (default "" for no partition).	''

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_directed_call_park

list_directed_call_park(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List DirectedCallPark objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_directed_call_park

apply_directed_call_park(name: str) -> Dict[str, Any]

Apply configuration for a DirectedCallPark.

Parameters:

Name	Type	Description	Default
name	str	The DirectedCallPark name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_directed_call_park

reset_directed_call_park(name: str) -> Dict[str, Any]

Reset a DirectedCallPark.

Parameters:

Name	Type	Description	Default
name	str	The DirectedCallPark name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_directory_lookup_dial_rules

get_directory_lookup_dial_rules(name: str) -> Dict[str, Any]

Retrieve a DirectoryLookupDialRules by name.

Parameters:

Name	Type	Description	Default
name	str	The DirectoryLookupDialRules name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_directory_lookup_dial_rules

add_directory_lookup_dial_rules(directory_lookup_dial_rules_data: DirectoryLookupDialRules) -> Dict[str, Any]

Add a new DirectoryLookupDialRules.

Parameters:

Name	Type	Description	Default
directory_lookup_dial_rules_data	DirectoryLookupDialRules	A dict describing the DirectoryLookupDialRules.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_directory_lookup_dial_rules

update_directory_lookup_dial_rules(**kwargs: Unpack[UpdateDirectoryLookupDialRules]) -> Dict[str, Any]

Update an existing DirectoryLookupDialRules.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateDirectoryLookupDialRules]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_directory_lookup_dial_rules

remove_directory_lookup_dial_rules(name: str) -> Dict[str, Any]

Remove a DirectoryLookupDialRules by name.

Parameters:

Name	Type	Description	Default
name	str	The DirectoryLookupDialRules name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_directory_lookup_dial_rules

list_directory_lookup_dial_rules(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List DirectoryLookupDialRules objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_elin_group

get_elin_group(name: str) -> Dict[str, Any]

Retrieve a ElinGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The ElinGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_elin_group

add_elin_group(elin_group_data: ElinGroup) -> Dict[str, Any]

Add a new ElinGroup.

Parameters:

Name	Type	Description	Default
elin_group_data	ElinGroup	A dict describing the ElinGroup.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_elin_group

update_elin_group(**kwargs: Unpack[UpdateElinGroup]) -> Dict[str, Any]

Update an existing ElinGroup.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateElinGroup]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_elin_group

remove_elin_group(name: str) -> Dict[str, Any]

Remove a ElinGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The ElinGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_elin_group

list_elin_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ElinGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_end_user_capf_profile

get_end_user_capf_profile(instance_id: str) -> Dict[str, Any]

Retrieve a EndUserCapfProfile by instance ID.

Parameters:

Name	Type	Description	Default
instance_id	str	The EndUserCapfProfile instance ID.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_end_user_capf_profile

add_end_user_capf_profile(end_user_capf_profile_data: EndUserCapfProfile) -> Dict[str, Any]

Add a new EndUserCapfProfile.

Parameters:

Name	Type	Description	Default
end_user_capf_profile_data	EndUserCapfProfile	A dict describing the EndUserCapfProfile.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_end_user_capf_profile

update_end_user_capf_profile(**kwargs: Unpack[UpdateEndUserCapfProfile]) -> Dict[str, Any]

Update an existing EndUserCapfProfile.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateEndUserCapfProfile]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_end_user_capf_profile

remove_end_user_capf_profile(instance_id: str) -> Dict[str, Any]

Remove a EndUserCapfProfile by instance ID.

Parameters:

Name	Type	Description	Default
instance_id	str	The EndUserCapfProfile instance ID.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_end_user_capf_profile

list_end_user_capf_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List EndUserCapfProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_enterprise_feature_access_configuration

get_enterprise_feature_access_configuration(name: str, **kwargs) -> Dict[str, Any]

Retrieve an EnterpriseFeatureAccessConfiguration by pattern.

Parameters:

Name	Type	Description	Default
name	str	The pattern.	required
**kwargs		Additional keyword args (e.g. routePartitionName).	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_enterprise_feature_access_configuration

add_enterprise_feature_access_configuration(enterprise_feature_access_configuration_data: EnterpriseFeatureAccessConfiguration) -> Dict[str, Any]

Add a new EnterpriseFeatureAccessConfiguration.

Parameters:

Name	Type	Description	Default
enterprise_feature_access_configuration_data	EnterpriseFeatureAccessConfiguration	A dict describing the EnterpriseFeatureAccessConfiguration.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_enterprise_feature_access_configuration

update_enterprise_feature_access_configuration(**kwargs: Unpack[UpdateEnterpriseFeatureAccessConfiguration]) -> Dict[str, Any]

Update an existing EnterpriseFeatureAccessConfiguration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateEnterpriseFeatureAccessConfiguration]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_enterprise_feature_access_configuration

remove_enterprise_feature_access_configuration(name: str, **kwargs) -> Dict[str, Any]

Remove an EnterpriseFeatureAccessConfiguration by pattern.

Parameters:

Name	Type	Description	Default
name	str	The pattern.	required
**kwargs		Additional keyword args (e.g. routePartitionName).	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_enterprise_feature_access_configuration

list_enterprise_feature_access_configuration(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List EnterpriseFeatureAccessConfiguration objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_expressway_c_configuration

get_expressway_c_configuration(name: str) -> Dict[str, Any]

Retrieve a ExpresswayCConfiguration by name.

Parameters:

Name	Type	Description	Default
name	str	The ExpresswayCConfiguration name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_expressway_c_configuration

add_expressway_c_configuration(expressway_c_configuration_data: ExpresswayCConfiguration) -> Dict[str, Any]

Add a new ExpresswayCConfiguration.

Parameters:

Name	Type	Description	Default
expressway_c_configuration_data	ExpresswayCConfiguration	A dict describing the ExpresswayCConfiguration.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_expressway_c_configuration

update_expressway_c_configuration(**kwargs: Unpack[UpdateExpresswayCConfiguration]) -> Dict[str, Any]

Update an existing ExpresswayCConfiguration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateExpresswayCConfiguration]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_expressway_c_configuration

remove_expressway_c_configuration(name: str) -> Dict[str, Any]

Remove a ExpresswayCConfiguration by name.

Parameters:

Name	Type	Description	Default
name	str	The ExpresswayCConfiguration name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_expressway_c_configuration

list_expressway_c_configuration(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ExpresswayCConfiguration objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_external_call_control_profile

get_external_call_control_profile(name: str) -> Dict[str, Any]

Retrieve a ExternalCallControlProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The ExternalCallControlProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_external_call_control_profile

add_external_call_control_profile(external_call_control_profile_data: ExternalCallControlProfile) -> Dict[str, Any]

Add a new ExternalCallControlProfile.

Parameters:

Name	Type	Description	Default
external_call_control_profile_data	ExternalCallControlProfile	A dict describing the ExternalCallControlProfile.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_external_call_control_profile

update_external_call_control_profile(**kwargs: Unpack[UpdateExternalCallControlProfile]) -> Dict[str, Any]

Update an existing ExternalCallControlProfile.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateExternalCallControlProfile]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_external_call_control_profile

remove_external_call_control_profile(name: str) -> Dict[str, Any]

Remove a ExternalCallControlProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The ExternalCallControlProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_external_call_control_profile

list_external_call_control_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ExternalCallControlProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_fac_info

get_fac_info(name: str) -> Dict[str, Any]

Retrieve a FacInfo by name.

Parameters:

Name	Type	Description	Default
name	str	The FacInfo name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_fac_info

add_fac_info(fac_info_data: FacInfo) -> Dict[str, Any]

Add a new FacInfo.

Parameters:

Name	Type	Description	Default
fac_info_data	FacInfo	A dict describing the FacInfo.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_fac_info

update_fac_info(**kwargs: Unpack[UpdateFacInfo]) -> Dict[str, Any]

Update an existing FacInfo.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateFacInfo]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_fac_info

remove_fac_info(name: str) -> Dict[str, Any]

Remove a FacInfo by name.

Parameters:

Name	Type	Description	Default
name	str	The FacInfo name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_fac_info

list_fac_info(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List FacInfo objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_fallback_profile

get_fallback_profile(name: str) -> Dict[str, Any]

Retrieve a FallbackProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The FallbackProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_fallback_profile

add_fallback_profile(fallback_profile_data: FallbackProfile) -> Dict[str, Any]

Add a new FallbackProfile.

Parameters:

Name	Type	Description	Default
fallback_profile_data	FallbackProfile	A dict describing the FallbackProfile.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_fallback_profile

update_fallback_profile(**kwargs: Unpack[UpdateFallbackProfile]) -> Dict[str, Any]

Update an existing FallbackProfile.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateFallbackProfile]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_fallback_profile

remove_fallback_profile(name: str) -> Dict[str, Any]

Remove a FallbackProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The FallbackProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_fallback_profile

list_fallback_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List FallbackProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_feature_control_policy

get_feature_control_policy(name: str) -> Dict[str, Any]

Retrieve a FeatureControlPolicy by name.

Parameters:

Name	Type	Description	Default
name	str	The FeatureControlPolicy name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_feature_control_policy

add_feature_control_policy(feature_control_policy_data: FeatureControlPolicy) -> Dict[str, Any]

Add a new FeatureControlPolicy.

Parameters:

Name	Type	Description	Default
feature_control_policy_data	FeatureControlPolicy	A dict describing the FeatureControlPolicy.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_feature_control_policy

update_feature_control_policy(**kwargs: Unpack[UpdateFeatureControlPolicy]) -> Dict[str, Any]

Update an existing FeatureControlPolicy.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateFeatureControlPolicy]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_feature_control_policy

remove_feature_control_policy(name: str) -> Dict[str, Any]

Remove a FeatureControlPolicy by name.

Parameters:

Name	Type	Description	Default
name	str	The FeatureControlPolicy name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_feature_control_policy

list_feature_control_policy(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List FeatureControlPolicy objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_feature_group_template

get_feature_group_template(name: str) -> Dict[str, Any]

Retrieve a FeatureGroupTemplate by name.

Parameters:

Name	Type	Description	Default
name	str	The FeatureGroupTemplate name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_feature_group_template

add_feature_group_template(feature_group_template_data: FeatureGroupTemplate) -> Dict[str, Any]

Add a new FeatureGroupTemplate.

Parameters:

Name	Type	Description	Default
feature_group_template_data	FeatureGroupTemplate	A dict describing the FeatureGroupTemplate.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_feature_group_template

update_feature_group_template(**kwargs: Unpack[UpdateFeatureGroupTemplate]) -> Dict[str, Any]

Update an existing FeatureGroupTemplate.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateFeatureGroupTemplate]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_feature_group_template

remove_feature_group_template(name: str) -> Dict[str, Any]

Remove a FeatureGroupTemplate by name.

Parameters:

Name	Type	Description	Default
name	str	The FeatureGroupTemplate name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_feature_group_template

list_feature_group_template(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List FeatureGroupTemplate objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_gatekeeper

get_gatekeeper(name: str) -> Dict[str, Any]

Retrieve a Gatekeeper by name.

Parameters:

Name	Type	Description	Default
name	str	The Gatekeeper name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_gatekeeper

add_gatekeeper(gatekeeper_data: Gatekeeper) -> Dict[str, Any]

Add a new Gatekeeper.

Parameters:

Name	Type	Description	Default
gatekeeper_data	Gatekeeper	A dict describing the Gatekeeper.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_gatekeeper

update_gatekeeper(**kwargs: Unpack[UpdateGatekeeper]) -> Dict[str, Any]

Update an existing Gatekeeper.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateGatekeeper]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_gatekeeper

remove_gatekeeper(name: str) -> Dict[str, Any]

Remove a Gatekeeper by name.

Parameters:

Name	Type	Description	Default
name	str	The Gatekeeper name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_gatekeeper

list_gatekeeper(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List Gatekeeper objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_gatekeeper

apply_gatekeeper(name: str) -> Dict[str, Any]

Apply configuration for a Gatekeeper.

Parameters:

Name	Type	Description	Default
name	str	The Gatekeeper name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_gatekeeper

reset_gatekeeper(name: str) -> Dict[str, Any]

Reset a Gatekeeper.

Parameters:

Name	Type	Description	Default
name	str	The Gatekeeper name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_gatekeeper

restart_gatekeeper(name: str) -> Dict[str, Any]

Restart a Gatekeeper.

Parameters:

Name	Type	Description	Default
name	str	The Gatekeeper name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_gateway

get_gateway(domain_name: str = '', **kwargs) -> Dict[str, Any]

Retrieve a Gateway by domainName.

Parameters:

Name	Type	Description	Default
domain_name	str	The Gateway domain name.	''
**kwargs		Additional keyword arguments (e.g., uuid).	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_gateway

add_gateway(gateway_data: Gateway) -> Dict[str, Any]

Add a new Gateway.

Parameters:

Name	Type	Description	Default
gateway_data	Gateway	A dict describing the Gateway.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_gateway

update_gateway(**kwargs: Unpack[UpdateGateway]) -> Dict[str, Any]

Update an existing Gateway.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateGateway]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_gateway

remove_gateway(domain_name: str = '', **kwargs) -> Dict[str, Any]

Remove a Gateway by domainName.

Parameters:

Name	Type	Description	Default
domain_name	str	The Gateway domain name.	''
**kwargs		Additional keyword arguments (e.g., uuid).	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_gateway

list_gateway(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List Gateway objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_gateway

apply_gateway(name: str) -> Dict[str, Any]

Apply configuration for a Gateway.

Parameters:

Name	Type	Description	Default
name	str	The Gateway name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_gateway

reset_gateway(name: str) -> Dict[str, Any]

Reset a Gateway.

Parameters:

Name	Type	Description	Default
name	str	The Gateway name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_gateway

restart_gateway(name: str) -> Dict[str, Any]

Restart a Gateway.

Parameters:

Name	Type	Description	Default
name	str	The Gateway name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_gateway_endpoint_analog_access

get_gateway_endpoint_analog_access(name: str) -> Dict[str, Any]

Retrieve a GatewayEndpointAnalogAccess by name.

Parameters:

Name	Type	Description	Default
name	str	The GatewayEndpointAnalogAccess name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_gateway_endpoint_analog_access

add_gateway_endpoint_analog_access(gateway_endpoint_analog_access_data: GatewayEndpointAnalogAccess) -> Dict[str, Any]

Add a new GatewayEndpointAnalogAccess.

Parameters:

Name	Type	Description	Default
gateway_endpoint_analog_access_data	GatewayEndpointAnalogAccess	A dict describing the GatewayEndpointAnalogAccess.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_gateway_endpoint_analog_access

update_gateway_endpoint_analog_access(**kwargs: Unpack[UpdateGatewayEndpointAnalogAccess]) -> Dict[str, Any]

Update an existing GatewayEndpointAnalogAccess.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateGatewayEndpointAnalogAccess]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_gateway_endpoint_analog_access

remove_gateway_endpoint_analog_access(name: str) -> Dict[str, Any]

Remove a GatewayEndpointAnalogAccess by name.

Parameters:

Name	Type	Description	Default
name	str	The GatewayEndpointAnalogAccess name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_gateway_endpoint_digital_access_bri

get_gateway_endpoint_digital_access_bri(name: str) -> Dict[str, Any]

Retrieve a GatewayEndpointDigitalAccessBri by name.

Parameters:

Name	Type	Description	Default
name	str	The GatewayEndpointDigitalAccessBri name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_gateway_endpoint_digital_access_bri

add_gateway_endpoint_digital_access_bri(gateway_endpoint_digital_access_bri_data: GatewayEndpointDigitalAccessBri) -> Dict[str, Any]

Add a new GatewayEndpointDigitalAccessBri.

Parameters:

Name	Type	Description	Default
gateway_endpoint_digital_access_bri_data	GatewayEndpointDigitalAccessBri	A dict describing the GatewayEndpointDigitalAccessBri.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_gateway_endpoint_digital_access_bri

update_gateway_endpoint_digital_access_bri(**kwargs: Unpack[UpdateGatewayEndpointDigitalAccessBri]) -> Dict[str, Any]

Update an existing GatewayEndpointDigitalAccessBri.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateGatewayEndpointDigitalAccessBri]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_gateway_endpoint_digital_access_bri

remove_gateway_endpoint_digital_access_bri(name: str) -> Dict[str, Any]

Remove a GatewayEndpointDigitalAccessBri by name.

Parameters:

Name	Type	Description	Default
name	str	The GatewayEndpointDigitalAccessBri name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_gateway_endpoint_digital_access_pri

get_gateway_endpoint_digital_access_pri(name: str) -> Dict[str, Any]

Retrieve a GatewayEndpointDigitalAccessPri by name.

Parameters:

Name	Type	Description	Default
name	str	The GatewayEndpointDigitalAccessPri name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_gateway_endpoint_digital_access_pri

add_gateway_endpoint_digital_access_pri(gateway_endpoint_digital_access_pri_data: GatewayEndpointDigitalAccessPri) -> Dict[str, Any]

Add a new GatewayEndpointDigitalAccessPri.

Parameters:

Name	Type	Description	Default
gateway_endpoint_digital_access_pri_data	GatewayEndpointDigitalAccessPri	A dict describing the GatewayEndpointDigitalAccessPri.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_gateway_endpoint_digital_access_pri

update_gateway_endpoint_digital_access_pri(**kwargs: Unpack[UpdateGatewayEndpointDigitalAccessPri]) -> Dict[str, Any]

Update an existing GatewayEndpointDigitalAccessPri.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateGatewayEndpointDigitalAccessPri]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_gateway_endpoint_digital_access_pri

remove_gateway_endpoint_digital_access_pri(name: str) -> Dict[str, Any]

Remove a GatewayEndpointDigitalAccessPri by name.

Parameters:

Name	Type	Description	Default
name	str	The GatewayEndpointDigitalAccessPri name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_gateway_endpoint_digital_access_t1

get_gateway_endpoint_digital_access_t1(name: str) -> Dict[str, Any]

Retrieve a GatewayEndpointDigitalAccessT1 by name.

Parameters:

Name	Type	Description	Default
name	str	The GatewayEndpointDigitalAccessT1 name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_gateway_endpoint_digital_access_t1

add_gateway_endpoint_digital_access_t1(gateway_endpoint_digital_access_t1_data: GatewayEndpointDigitalAccessT1) -> Dict[str, Any]

Add a new GatewayEndpointDigitalAccessT1.

Parameters:

Name	Type	Description	Default
gateway_endpoint_digital_access_t1_data	GatewayEndpointDigitalAccessT1	A dict describing the GatewayEndpointDigitalAccessT1.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_gateway_endpoint_digital_access_t1

update_gateway_endpoint_digital_access_t1(**kwargs: Unpack[UpdateGatewayEndpointDigitalAccessT1]) -> Dict[str, Any]

Update an existing GatewayEndpointDigitalAccessT1.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateGatewayEndpointDigitalAccessT1]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_gateway_endpoint_digital_access_t1

remove_gateway_endpoint_digital_access_t1(name: str) -> Dict[str, Any]

Remove a GatewayEndpointDigitalAccessT1 by name.

Parameters:

Name	Type	Description	Default
name	str	The GatewayEndpointDigitalAccessT1 name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_gateway_sccp_endpoints

get_gateway_sccp_endpoints(name: str) -> Dict[str, Any]

Retrieve a GatewaySccpEndpoints by name.

Parameters:

Name	Type	Description	Default
name	str	The GatewaySccpEndpoints name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_gateway_sccp_endpoints

add_gateway_sccp_endpoints(gateway_sccp_endpoints_data: GatewaySccpEndpoints) -> Dict[str, Any]

Add a new GatewaySccpEndpoints.

Parameters:

Name	Type	Description	Default
gateway_sccp_endpoints_data	GatewaySccpEndpoints	A dict describing the GatewaySccpEndpoints.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_gateway_sccp_endpoints

update_gateway_sccp_endpoints(**kwargs: Unpack[UpdateGatewaySccpEndpoints]) -> Dict[str, Any]

Update an existing GatewaySccpEndpoints.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateGatewaySccpEndpoints]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_gateway_sccp_endpoints

remove_gateway_sccp_endpoints(name: str) -> Dict[str, Any]

Remove a GatewaySccpEndpoints by name.

Parameters:

Name	Type	Description	Default
name	str	The GatewaySccpEndpoints name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_gateway_subunits

add_gateway_subunits(gateway_subunits_data: GatewaySubunits) -> Dict[str, Any]

Add a new GatewaySubunits.

Parameters:

Name	Type	Description	Default
gateway_subunits_data	GatewaySubunits	A dict describing the GatewaySubunits.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

remove_gateway_subunits

remove_gateway_subunits(name: str) -> Dict[str, Any]

Remove a GatewaySubunits by name.

Parameters:

Name	Type	Description	Default
name	str	The GatewaySubunits name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_geo_location

get_geo_location(name: str) -> Dict[str, Any]

Retrieve a GeoLocation by name.

Parameters:

Name	Type	Description	Default
name	str	The GeoLocation name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_geo_location

add_geo_location(geo_location_data: GeoLocation) -> Dict[str, Any]

Add a new GeoLocation.

Parameters:

Name	Type	Description	Default
geo_location_data	GeoLocation	A dict describing the GeoLocation.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_geo_location

update_geo_location(**kwargs: Unpack[UpdateGeoLocation]) -> Dict[str, Any]

Update an existing GeoLocation.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateGeoLocation]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_geo_location

remove_geo_location(name: str) -> Dict[str, Any]

Remove a GeoLocation by name.

Parameters:

Name	Type	Description	Default
name	str	The GeoLocation name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_geo_location

list_geo_location(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List GeoLocation objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_geo_location_filter

get_geo_location_filter(name: str) -> Dict[str, Any]

Retrieve a GeoLocationFilter by name.

Parameters:

Name	Type	Description	Default
name	str	The GeoLocationFilter name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_geo_location_filter

add_geo_location_filter(geo_location_filter_data: GeoLocationFilter) -> Dict[str, Any]

Add a new GeoLocationFilter.

Parameters:

Name	Type	Description	Default
geo_location_filter_data	GeoLocationFilter	A dict describing the GeoLocationFilter.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_geo_location_filter

update_geo_location_filter(**kwargs: Unpack[UpdateGeoLocationFilter]) -> Dict[str, Any]

Update an existing GeoLocationFilter.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateGeoLocationFilter]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_geo_location_filter

remove_geo_location_filter(name: str) -> Dict[str, Any]

Remove a GeoLocationFilter by name.

Parameters:

Name	Type	Description	Default
name	str	The GeoLocationFilter name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_geo_location_filter

list_geo_location_filter(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List GeoLocationFilter objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_geo_location_policy

get_geo_location_policy(name: str) -> Dict[str, Any]

Retrieve a GeoLocationPolicy by name.

Parameters:

Name	Type	Description	Default
name	str	The GeoLocationPolicy name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_geo_location_policy

add_geo_location_policy(geo_location_policy_data: GeoLocationPolicy) -> Dict[str, Any]

Add a new GeoLocationPolicy.

Parameters:

Name	Type	Description	Default
geo_location_policy_data	GeoLocationPolicy	A dict describing the GeoLocationPolicy.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_geo_location_policy

update_geo_location_policy(**kwargs: Unpack[UpdateGeoLocationPolicy]) -> Dict[str, Any]

Update an existing GeoLocationPolicy.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateGeoLocationPolicy]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_geo_location_policy

remove_geo_location_policy(name: str) -> Dict[str, Any]

Remove a GeoLocationPolicy by name.

Parameters:

Name	Type	Description	Default
name	str	The GeoLocationPolicy name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_geo_location_policy

list_geo_location_policy(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List GeoLocationPolicy objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_h323_gateway

list_h323_gateway(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List H323Gateway objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_h323_gateway

apply_h323_gateway(name: str) -> Dict[str, Any]

Apply configuration for a H323Gateway.

Parameters:

Name	Type	Description	Default
name	str	The H323Gateway name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_h323_gateway

reset_h323_gateway(name: str) -> Dict[str, Any]

Reset a H323Gateway.

Parameters:

Name	Type	Description	Default
name	str	The H323Gateway name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_h323_gateway

restart_h323_gateway(name: str) -> Dict[str, Any]

Restart a H323Gateway.

Parameters:

Name	Type	Description	Default
name	str	The H323Gateway name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_h323_phone

get_h323_phone(name: str) -> Dict[str, Any]

Retrieve a H323Phone by name.

Parameters:

Name	Type	Description	Default
name	str	The H323Phone name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_h323_phone

add_h323_phone(h323_phone_data: H323Phone) -> Dict[str, Any]

Add a new H323Phone.

Parameters:

Name	Type	Description	Default
h323_phone_data	H323Phone	A dict describing the H323Phone.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_h323_phone

update_h323_phone(**kwargs: Unpack[UpdateH323Phone]) -> Dict[str, Any]

Update an existing H323Phone.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateH323Phone]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_h323_phone

remove_h323_phone(name: str) -> Dict[str, Any]

Remove a H323Phone by name.

Parameters:

Name	Type	Description	Default
name	str	The H323Phone name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_h323_phone

list_h323_phone(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List H323Phone objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_h323_phone

apply_h323_phone(name: str) -> Dict[str, Any]

Apply configuration for a H323Phone.

Parameters:

Name	Type	Description	Default
name	str	The H323Phone name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_h323_phone

reset_h323_phone(name: str) -> Dict[str, Any]

Reset a H323Phone.

Parameters:

Name	Type	Description	Default
name	str	The H323Phone name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_h323_phone

restart_h323_phone(name: str) -> Dict[str, Any]

Restart a H323Phone.

Parameters:

Name	Type	Description	Default
name	str	The H323Phone name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_h323_trunk

list_h323_trunk(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List H323Trunk objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_h323_trunk

reset_h323_trunk(name: str) -> Dict[str, Any]

Reset a H323Trunk.

Parameters:

Name	Type	Description	Default
name	str	The H323Trunk name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_h323_trunk

restart_h323_trunk(name: str) -> Dict[str, Any]

Restart a H323Trunk.

Parameters:

Name	Type	Description	Default
name	str	The H323Trunk name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_handoff_configuration

get_handoff_configuration(**kwargs) -> Dict[str, Any]

Retrieve a HandoffConfiguration.

Parameters:

Name	Type	Description	Default
**kwargs		Must include pattern (and optionally routePartitionName); or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_handoff_configuration

add_handoff_configuration(handoff_configuration_data: HandoffConfiguration) -> Dict[str, Any]

Add a new HandoffConfiguration.

Parameters:

Name	Type	Description	Default
handoff_configuration_data	HandoffConfiguration	A dict describing the HandoffConfiguration.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_handoff_configuration

update_handoff_configuration(**kwargs: Unpack[UpdateHandoffConfiguration]) -> Dict[str, Any]

Update an existing HandoffConfiguration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateHandoffConfiguration]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_handoff_configuration

remove_handoff_configuration(**kwargs) -> Dict[str, Any]

Remove a HandoffConfiguration.

Parameters:

Name	Type	Description	Default
**kwargs		Must include pattern (and optionally routePartitionName); or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_http_profile

get_http_profile(name: str) -> Dict[str, Any]

Retrieve a HttpProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The HttpProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_http_profile

add_http_profile(http_profile_data: HttpProfile) -> Dict[str, Any]

Add a new HttpProfile.

Parameters:

Name	Type	Description	Default
http_profile_data	HttpProfile	A dict describing the HttpProfile.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_http_profile

update_http_profile(**kwargs: Unpack[UpdateHttpProfile]) -> Dict[str, Any]

Update an existing HttpProfile.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateHttpProfile]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_http_profile

remove_http_profile(name: str) -> Dict[str, Any]

Remove a HttpProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The HttpProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_hunt_list

list_hunt_list(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List HuntList objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_hunt_list

apply_hunt_list(name: str) -> Dict[str, Any]

Apply configuration for a HuntList.

Parameters:

Name	Type	Description	Default
name	str	The HuntList name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_hunt_list

reset_hunt_list(name: str) -> Dict[str, Any]

Reset a HuntList.

Parameters:

Name	Type	Description	Default
name	str	The HuntList name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_hunt_pilot

list_hunt_pilot(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List HuntPilot objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ime_client

get_ime_client(name: str) -> Dict[str, Any]

Retrieve a ImeClient by name.

Parameters:

Name	Type	Description	Default
name	str	The ImeClient name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_ime_client

add_ime_client(ime_client_data: ImeClient) -> Dict[str, Any]

Add a new ImeClient.

Parameters:

Name	Type	Description	Default
ime_client_data	ImeClient	A dict describing the ImeClient.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ime_client

update_ime_client(**kwargs: Unpack[UpdateImeClient]) -> Dict[str, Any]

Update an existing ImeClient.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateImeClient]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_ime_client

remove_ime_client(name: str) -> Dict[str, Any]

Remove a ImeClient by name.

Parameters:

Name	Type	Description	Default
name	str	The ImeClient name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ime_client

list_ime_client(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ImeClient objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ime_e164_transformation

get_ime_e164_transformation(name: str) -> Dict[str, Any]

Retrieve a ImeE164Transformation by name.

Parameters:

Name	Type	Description	Default
name	str	The ImeE164Transformation name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_ime_e164_transformation

add_ime_e164_transformation(ime_e164_transformation_data: ImeE164Transformation) -> Dict[str, Any]

Add a new ImeE164Transformation.

Parameters:

Name	Type	Description	Default
ime_e164_transformation_data	ImeE164Transformation	A dict describing the ImeE164Transformation.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ime_e164_transformation

update_ime_e164_transformation(**kwargs: Unpack[UpdateImeE164Transformation]) -> Dict[str, Any]

Update an existing ImeE164Transformation.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateImeE164Transformation]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_ime_e164_transformation

remove_ime_e164_transformation(name: str) -> Dict[str, Any]

Remove a ImeE164Transformation by name.

Parameters:

Name	Type	Description	Default
name	str	The ImeE164Transformation name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ime_e164_transformation

list_ime_e164_transformation(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ImeE164Transformation objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ime_enrolled_pattern

get_ime_enrolled_pattern(pattern: str) -> Dict[str, Any]

Retrieve a ImeEnrolledPattern by pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The ImeEnrolledPattern pattern.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_ime_enrolled_pattern

add_ime_enrolled_pattern(ime_enrolled_pattern_data: ImeEnrolledPattern) -> Dict[str, Any]

Add a new ImeEnrolledPattern.

Parameters:

Name	Type	Description	Default
ime_enrolled_pattern_data	ImeEnrolledPattern	A dict describing the ImeEnrolledPattern.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ime_enrolled_pattern

update_ime_enrolled_pattern(**kwargs: Unpack[UpdateImeEnrolledPattern]) -> Dict[str, Any]

Update an existing ImeEnrolledPattern.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateImeEnrolledPattern]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_ime_enrolled_pattern

remove_ime_enrolled_pattern(pattern: str) -> Dict[str, Any]

Remove a ImeEnrolledPattern by pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The ImeEnrolledPattern pattern.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ime_enrolled_pattern

list_ime_enrolled_pattern(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ImeEnrolledPattern objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ime_enrolled_pattern_group

get_ime_enrolled_pattern_group(name: str) -> Dict[str, Any]

Retrieve a ImeEnrolledPatternGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The ImeEnrolledPatternGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_ime_enrolled_pattern_group

add_ime_enrolled_pattern_group(ime_enrolled_pattern_group_data: ImeEnrolledPatternGroup) -> Dict[str, Any]

Add a new ImeEnrolledPatternGroup.

Parameters:

Name	Type	Description	Default
ime_enrolled_pattern_group_data	ImeEnrolledPatternGroup	A dict describing the ImeEnrolledPatternGroup.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ime_enrolled_pattern_group

update_ime_enrolled_pattern_group(**kwargs: Unpack[UpdateImeEnrolledPatternGroup]) -> Dict[str, Any]

Update an existing ImeEnrolledPatternGroup.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateImeEnrolledPatternGroup]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_ime_enrolled_pattern_group

remove_ime_enrolled_pattern_group(name: str) -> Dict[str, Any]

Remove a ImeEnrolledPatternGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The ImeEnrolledPatternGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ime_enrolled_pattern_group

list_ime_enrolled_pattern_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ImeEnrolledPatternGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ime_exclusion_number

get_ime_exclusion_number(pattern: str) -> Dict[str, Any]

Retrieve a ImeExclusionNumber by pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The ImeExclusionNumber pattern.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_ime_exclusion_number

add_ime_exclusion_number(ime_exclusion_number_data: ImeExclusionNumber) -> Dict[str, Any]

Add a new ImeExclusionNumber.

Parameters:

Name	Type	Description	Default
ime_exclusion_number_data	ImeExclusionNumber	A dict describing the ImeExclusionNumber.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ime_exclusion_number

update_ime_exclusion_number(**kwargs: Unpack[UpdateImeExclusionNumber]) -> Dict[str, Any]

Update an existing ImeExclusionNumber.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateImeExclusionNumber]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_ime_exclusion_number

remove_ime_exclusion_number(pattern: str) -> Dict[str, Any]

Remove a ImeExclusionNumber by pattern.

Parameters:

Name	Type	Description	Default
pattern	str	The ImeExclusionNumber pattern.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ime_exclusion_number

list_ime_exclusion_number(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ImeExclusionNumber objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ime_exclusion_number_group

get_ime_exclusion_number_group(name: str) -> Dict[str, Any]

Retrieve a ImeExclusionNumberGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The ImeExclusionNumberGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_ime_exclusion_number_group

add_ime_exclusion_number_group(ime_exclusion_number_group_data: ImeExclusionNumberGroup) -> Dict[str, Any]

Add a new ImeExclusionNumberGroup.

Parameters:

Name	Type	Description	Default
ime_exclusion_number_group_data	ImeExclusionNumberGroup	A dict describing the ImeExclusionNumberGroup.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ime_exclusion_number_group

update_ime_exclusion_number_group(**kwargs: Unpack[UpdateImeExclusionNumberGroup]) -> Dict[str, Any]

Update an existing ImeExclusionNumberGroup.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateImeExclusionNumberGroup]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_ime_exclusion_number_group

remove_ime_exclusion_number_group(name: str) -> Dict[str, Any]

Remove a ImeExclusionNumberGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The ImeExclusionNumberGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ime_exclusion_number_group

list_ime_exclusion_number_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ImeExclusionNumberGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ime_firewall

get_ime_firewall(name: str) -> Dict[str, Any]

Retrieve a ImeFirewall by name.

Parameters:

Name	Type	Description	Default
name	str	The ImeFirewall name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_ime_firewall

add_ime_firewall(ime_firewall_data: ImeFirewall) -> Dict[str, Any]

Add a new ImeFirewall.

Parameters:

Name	Type	Description	Default
ime_firewall_data	ImeFirewall	A dict describing the ImeFirewall.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ime_firewall

update_ime_firewall(**kwargs: Unpack[UpdateImeFirewall]) -> Dict[str, Any]

Update an existing ImeFirewall.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateImeFirewall]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_ime_firewall

remove_ime_firewall(name: str) -> Dict[str, Any]

Remove a ImeFirewall by name.

Parameters:

Name	Type	Description	Default
name	str	The ImeFirewall name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ime_firewall

list_ime_firewall(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ImeFirewall objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ime_route_filter_element

get_ime_route_filter_element(name: str) -> Dict[str, Any]

Retrieve a ImeRouteFilterElement by name.

Parameters:

Name	Type	Description	Default
name	str	The ImeRouteFilterElement name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_ime_route_filter_element

add_ime_route_filter_element(ime_route_filter_element_data: ImeRouteFilterElement) -> Dict[str, Any]

Add a new ImeRouteFilterElement.

Parameters:

Name	Type	Description	Default
ime_route_filter_element_data	ImeRouteFilterElement	A dict describing the ImeRouteFilterElement.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ime_route_filter_element

update_ime_route_filter_element(**kwargs: Unpack[UpdateImeRouteFilterElement]) -> Dict[str, Any]

Update an existing ImeRouteFilterElement.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateImeRouteFilterElement]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_ime_route_filter_element

remove_ime_route_filter_element(name: str) -> Dict[str, Any]

Remove a ImeRouteFilterElement by name.

Parameters:

Name	Type	Description	Default
name	str	The ImeRouteFilterElement name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ime_route_filter_element

list_ime_route_filter_element(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ImeRouteFilterElement objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ime_route_filter_group

get_ime_route_filter_group(name: str) -> Dict[str, Any]

Retrieve a ImeRouteFilterGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The ImeRouteFilterGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_ime_route_filter_group

add_ime_route_filter_group(ime_route_filter_group_data: ImeRouteFilterGroup) -> Dict[str, Any]

Add a new ImeRouteFilterGroup.

Parameters:

Name	Type	Description	Default
ime_route_filter_group_data	ImeRouteFilterGroup	A dict describing the ImeRouteFilterGroup.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ime_route_filter_group

update_ime_route_filter_group(**kwargs: Unpack[UpdateImeRouteFilterGroup]) -> Dict[str, Any]

Update an existing ImeRouteFilterGroup.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateImeRouteFilterGroup]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_ime_route_filter_group

remove_ime_route_filter_group(name: str) -> Dict[str, Any]

Remove a ImeRouteFilterGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The ImeRouteFilterGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ime_route_filter_group

list_ime_route_filter_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ImeRouteFilterGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ime_server

get_ime_server(name: str) -> Dict[str, Any]

Retrieve a ImeServer by name.

Parameters:

Name	Type	Description	Default
name	str	The ImeServer name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_ime_server

add_ime_server(ime_server_data: ImeServer) -> Dict[str, Any]

Add a new ImeServer.

Parameters:

Name	Type	Description	Default
ime_server_data	ImeServer	A dict describing the ImeServer.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ime_server

update_ime_server(**kwargs: Unpack[UpdateImeServer]) -> Dict[str, Any]

Update an existing ImeServer.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateImeServer]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_ime_server

remove_ime_server(name: str) -> Dict[str, Any]

Remove a ImeServer by name.

Parameters:

Name	Type	Description	Default
name	str	The ImeServer name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ime_server

list_ime_server(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ImeServer objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_imported_directory_uri_catalogs

get_imported_directory_uri_catalogs(name: str) -> Dict[str, Any]

Retrieve a ImportedDirectoryUriCatalogs by name.

Parameters:

Name	Type	Description	Default
name	str	The ImportedDirectoryUriCatalogs name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_imported_directory_uri_catalogs

add_imported_directory_uri_catalogs(imported_directory_uri_catalogs_data: ImportedDirectoryUriCatalogs) -> Dict[str, Any]

Add a new ImportedDirectoryUriCatalogs.

Parameters:

Name	Type	Description	Default
imported_directory_uri_catalogs_data	ImportedDirectoryUriCatalogs	A dict describing the ImportedDirectoryUriCatalogs.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_imported_directory_uri_catalogs

update_imported_directory_uri_catalogs(**kwargs: Unpack[UpdateImportedDirectoryUriCatalogs]) -> Dict[str, Any]

Update an existing ImportedDirectoryUriCatalogs.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateImportedDirectoryUriCatalogs]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_imported_directory_uri_catalogs

remove_imported_directory_uri_catalogs(name: str) -> Dict[str, Any]

Remove a ImportedDirectoryUriCatalogs by name.

Parameters:

Name	Type	Description	Default
name	str	The ImportedDirectoryUriCatalogs name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_imported_directory_uri_catalogs

list_imported_directory_uri_catalogs(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ImportedDirectoryUriCatalogs objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_infrastructure_device

get_infrastructure_device(uuid: str) -> Dict[str, Any]

Retrieve an InfrastructureDevice by UUID.

Parameters:

Name	Type	Description	Default
uuid	str	The InfrastructureDevice UUID.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_infrastructure_device

add_infrastructure_device(infrastructure_device_data: InfrastructureDevice) -> Dict[str, Any]

Add a new InfrastructureDevice.

Parameters:

Name	Type	Description	Default
infrastructure_device_data	InfrastructureDevice	A dict describing the InfrastructureDevice.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_infrastructure_device

update_infrastructure_device(**kwargs: Unpack[UpdateInfrastructureDevice]) -> Dict[str, Any]

Update an existing InfrastructureDevice.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateInfrastructureDevice]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_infrastructure_device

remove_infrastructure_device(uuid: str) -> Dict[str, Any]

Remove an InfrastructureDevice by UUID.

Parameters:

Name	Type	Description	Default
uuid	str	The InfrastructureDevice UUID.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_infrastructure_device

list_infrastructure_device(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List InfrastructureDevice objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_interactive_voice_response

get_interactive_voice_response(name: str) -> Dict[str, Any]

Retrieve a InteractiveVoiceResponse by name.

Parameters:

Name	Type	Description	Default
name	str	The InteractiveVoiceResponse name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

update_interactive_voice_response

update_interactive_voice_response(**kwargs: Unpack[UpdateInteractiveVoiceResponse]) -> Dict[str, Any]

Update an existing InteractiveVoiceResponse.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateInteractiveVoiceResponse]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_interactive_voice_response

list_interactive_voice_response(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List InteractiveVoiceResponse objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ip_phone_services

get_ip_phone_services(name: str) -> Dict[str, Any]

Retrieve an IP Phone Service by service name.

Parameters:

Name	Type	Description	Default
name	str	The IP Phone Service name (serviceName).	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_ip_phone_services

add_ip_phone_services(ip_phone_services_data: IpPhoneServices) -> Dict[str, Any]

Add a new IpPhoneServices.

Parameters:

Name	Type	Description	Default
ip_phone_services_data	IpPhoneServices	A dict describing the IpPhoneServices.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ip_phone_services

update_ip_phone_services(**kwargs: Unpack[UpdateIpPhoneServices]) -> Dict[str, Any]

Update an existing IpPhoneServices.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateIpPhoneServices]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_ip_phone_services

remove_ip_phone_services(name: str) -> Dict[str, Any]

Remove an IP Phone Service by service name.

Parameters:

Name	Type	Description	Default
name	str	The IP Phone Service name (serviceName).	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ip_phone_services

list_ip_phone_services(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List IpPhoneServices objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ivr_user_locale

get_ivr_user_locale(user_locale: str) -> Dict[str, Any]

Retrieve a IvrUserLocale by userLocale.

Parameters:

Name	Type	Description	Default
user_locale	str	The IvrUserLocale userLocale.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_ivr_user_locale

add_ivr_user_locale(ivr_user_locale_data: IvrUserLocale) -> Dict[str, Any]

Add a new IvrUserLocale.

Parameters:

Name	Type	Description	Default
ivr_user_locale_data	IvrUserLocale	A dict describing the IvrUserLocale.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ivr_user_locale

update_ivr_user_locale(**kwargs: Unpack[UpdateIvrUserLocale]) -> Dict[str, Any]

Update an existing IvrUserLocale.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateIvrUserLocale]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_ivr_user_locale

remove_ivr_user_locale(user_locale: str) -> Dict[str, Any]

Remove a IvrUserLocale by userLocale.

Parameters:

Name	Type	Description	Default
user_locale	str	The IvrUserLocale userLocale.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ivr_user_locale

list_ivr_user_locale(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List IvrUserLocale objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_lbm_group

get_lbm_group(name: str) -> Dict[str, Any]

Retrieve a LbmGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The LbmGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_lbm_group

add_lbm_group(lbm_group_data: LbmGroup) -> Dict[str, Any]

Add a new LbmGroup.

Parameters:

Name	Type	Description	Default
lbm_group_data	LbmGroup	A dict describing the LbmGroup.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_lbm_group

update_lbm_group(**kwargs: Unpack[UpdateLbmGroup]) -> Dict[str, Any]

Update an existing LbmGroup.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateLbmGroup]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_lbm_group

remove_lbm_group(name: str) -> Dict[str, Any]

Remove a LbmGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The LbmGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_lbm_group

list_lbm_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List LbmGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_lbm_hub_group

get_lbm_hub_group(name: str) -> Dict[str, Any]

Retrieve a LbmHubGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The LbmHubGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_lbm_hub_group

add_lbm_hub_group(lbm_hub_group_data: LbmHubGroup) -> Dict[str, Any]

Add a new LbmHubGroup.

Parameters:

Name	Type	Description	Default
lbm_hub_group_data	LbmHubGroup	A dict describing the LbmHubGroup.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_lbm_hub_group

update_lbm_hub_group(**kwargs: Unpack[UpdateLbmHubGroup]) -> Dict[str, Any]

Update an existing LbmHubGroup.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateLbmHubGroup]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_lbm_hub_group

remove_lbm_hub_group(name: str) -> Dict[str, Any]

Remove a LbmHubGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The LbmHubGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_lbm_hub_group

list_lbm_hub_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List LbmHubGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ldap_directory

update_ldap_directory(**kwargs: Unpack[UpdateLdapDirectory]) -> Dict[str, Any]

Update an existing LdapDirectory.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateLdapDirectory]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ldap_directory

list_ldap_directory(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List LdapDirectory objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ldap_filter

update_ldap_filter(**kwargs: Unpack[UpdateLdapFilter]) -> Dict[str, Any]

Update an existing LdapFilter.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateLdapFilter]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ldap_filter

list_ldap_filter(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List LdapFilter objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ldap_search

get_ldap_search(name: str) -> Dict[str, Any]

Retrieve a LdapSearch by name.

Parameters:

Name	Type	Description	Default
name	str	The LdapSearch name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

update_ldap_search

update_ldap_search(**kwargs: Unpack[UpdateLdapSearch]) -> Dict[str, Any]

Update an existing LdapSearch.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateLdapSearch]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ldap_search

list_ldap_search(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List LdapSearch objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ldap_sync_custom_field

get_ldap_sync_custom_field(name: str) -> Dict[str, Any]

Retrieve a LdapSyncCustomField by name.

Parameters:

Name	Type	Description	Default
name	str	The LdapSyncCustomField name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_ldap_sync_custom_field

add_ldap_sync_custom_field(ldap_sync_custom_field_data: LdapSyncCustomField) -> Dict[str, Any]

Add a new LdapSyncCustomField.

Parameters:

Name	Type	Description	Default
ldap_sync_custom_field_data	LdapSyncCustomField	A dict describing the LdapSyncCustomField.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ldap_sync_custom_field

update_ldap_sync_custom_field(**kwargs: Unpack[UpdateLdapSyncCustomField]) -> Dict[str, Any]

Update an existing LdapSyncCustomField.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateLdapSyncCustomField]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_ldap_sync_custom_field

remove_ldap_sync_custom_field(name: str) -> Dict[str, Any]

Remove a LdapSyncCustomField by name.

Parameters:

Name	Type	Description	Default
name	str	The LdapSyncCustomField name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_ldap_sync_custom_field

list_ldap_sync_custom_field(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List LdapSyncCustomField objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_line

list_line(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List Line objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_line

apply_line(**kwargs) -> Dict[str, Any]

Apply configuration for a Line.

Parameters:

Name	Type	Description	Default
**kwargs		Keyword arguments passed to the WSDL operation. Typically pattern and routePartitionName.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_line

reset_line(**kwargs) -> Dict[str, Any]

Reset a Line.

Parameters:

Name	Type	Description	Default
**kwargs		Keyword arguments passed to the WSDL operation. Typically pattern and routePartitionName.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_line

restart_line(**kwargs) -> Dict[str, Any]

Restart a Line.

Parameters:

Name	Type	Description	Default
**kwargs		Keyword arguments passed to the WSDL operation. Typically pattern and routePartitionName.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_line_group

list_line_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List LineGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_local_route_group

get_local_route_group(name: str) -> Dict[str, Any]

Retrieve a LocalRouteGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The LocalRouteGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_local_route_group

add_local_route_group(local_route_group_data: LocalRouteGroup) -> Dict[str, Any]

Add a new LocalRouteGroup.

Parameters:

Name	Type	Description	Default
local_route_group_data	LocalRouteGroup	A dict describing the LocalRouteGroup.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_local_route_group

update_local_route_group(**kwargs: Unpack[UpdateLocalRouteGroup]) -> Dict[str, Any]

Update an existing LocalRouteGroup.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateLocalRouteGroup]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_local_route_group

remove_local_route_group(name: str) -> Dict[str, Any]

Remove a LocalRouteGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The LocalRouteGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_local_route_group

list_local_route_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List LocalRouteGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_location

list_location(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List Location objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_media_resource_group

update_media_resource_group(**kwargs: Unpack[UpdateMediaResourceGroup]) -> Dict[str, Any]

Update an existing MediaResourceGroup.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateMediaResourceGroup]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_media_resource_group

list_media_resource_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List MediaResourceGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_media_resource_list

update_media_resource_list(**kwargs: Unpack[UpdateMediaResourceList]) -> Dict[str, Any]

Update an existing MediaResourceList.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateMediaResourceList]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_media_resource_list

list_media_resource_list(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List MediaResourceList objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_meet_me

get_meet_me(name: str, **kwargs) -> Dict[str, Any]

Retrieve a MeetMe by pattern.

Parameters:

Name	Type	Description	Default
name	str	The pattern.	required
**kwargs		Additional keyword args (e.g. routePartitionName).	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_meet_me

add_meet_me(meet_me_data: MeetMe) -> Dict[str, Any]

Add a new MeetMe.

Parameters:

Name	Type	Description	Default
meet_me_data	MeetMe	A dict describing the MeetMe.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_meet_me

update_meet_me(**kwargs: Unpack[UpdateMeetMe]) -> Dict[str, Any]

Update an existing MeetMe.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateMeetMe]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_meet_me

remove_meet_me(name: str, **kwargs) -> Dict[str, Any]

Remove a MeetMe by pattern.

Parameters:

Name	Type	Description	Default
name	str	The pattern.	required
**kwargs		Additional keyword args (e.g. routePartitionName).	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_meet_me

list_meet_me(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List MeetMe objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_message_waiting

get_message_waiting(name: str, **kwargs) -> Dict[str, Any]

Retrieve a MessageWaiting by pattern.

Parameters:

Name	Type	Description	Default
name	str	The pattern.	required
**kwargs		Additional keyword args (e.g. routePartitionName).	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_message_waiting

add_message_waiting(message_waiting_data: MessageWaiting) -> Dict[str, Any]

Add a new MessageWaiting.

Parameters:

Name	Type	Description	Default
message_waiting_data	MessageWaiting	A dict describing the MessageWaiting.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_message_waiting

update_message_waiting(**kwargs: Unpack[UpdateMessageWaiting]) -> Dict[str, Any]

Update an existing MessageWaiting.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateMessageWaiting]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_message_waiting

remove_message_waiting(name: str, **kwargs) -> Dict[str, Any]

Remove a MessageWaiting by pattern.

Parameters:

Name	Type	Description	Default
name	str	The pattern.	required
**kwargs		Additional keyword args (e.g. routePartitionName).	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_message_waiting

list_message_waiting(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List MessageWaiting objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_mlpp_domain

get_mlpp_domain(name: str) -> Dict[str, Any]

Retrieve a MlppDomain by name.

Parameters:

Name	Type	Description	Default
name	str	The MlppDomain name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_mlpp_domain

add_mlpp_domain(mlpp_domain_data: MlppDomain) -> Dict[str, Any]

Add a new MlppDomain.

Parameters:

Name	Type	Description	Default
mlpp_domain_data	MlppDomain	A dict describing the MlppDomain.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_mlpp_domain

update_mlpp_domain(**kwargs: Unpack[UpdateMlppDomain]) -> Dict[str, Any]

Update an existing MlppDomain.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateMlppDomain]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_mlpp_domain

remove_mlpp_domain(name: str) -> Dict[str, Any]

Remove a MlppDomain by name.

Parameters:

Name	Type	Description	Default
name	str	The MlppDomain name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_mlpp_domain

list_mlpp_domain(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List MlppDomain objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_mobile_voice_access

get_mobile_voice_access(name: str) -> Dict[str, Any]

Retrieve a MobileVoiceAccess by name.

Parameters:

Name	Type	Description	Default
name	str	The MobileVoiceAccess name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_mobile_voice_access

add_mobile_voice_access(mobile_voice_access_data: MobileVoiceAccess) -> Dict[str, Any]

Add a new MobileVoiceAccess.

Parameters:

Name	Type	Description	Default
mobile_voice_access_data	MobileVoiceAccess	A dict describing the MobileVoiceAccess.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_mobile_voice_access

update_mobile_voice_access(**kwargs: Unpack[UpdateMobileVoiceAccess]) -> Dict[str, Any]

Update an existing MobileVoiceAccess.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateMobileVoiceAccess]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_mobile_voice_access

remove_mobile_voice_access(name: str) -> Dict[str, Any]

Remove a MobileVoiceAccess by name.

Parameters:

Name	Type	Description	Default
name	str	The MobileVoiceAccess name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_mobility

get_mobility(name: str) -> Dict[str, Any]

Retrieve a Mobility by name.

Parameters:

Name	Type	Description	Default
name	str	The Mobility name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_mobility

add_mobility(mobility_data: Mobility) -> Dict[str, Any]

Add a new Mobility.

Parameters:

Name	Type	Description	Default
mobility_data	Mobility	A dict describing the Mobility.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_mobility

update_mobility(**kwargs: Unpack[UpdateMobility]) -> Dict[str, Any]

Update an existing Mobility.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateMobility]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_mobility_profile

get_mobility_profile(name: str) -> Dict[str, Any]

Retrieve a MobilityProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The MobilityProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_mobility_profile

add_mobility_profile(mobility_profile_data: MobilityProfile) -> Dict[str, Any]

Add a new MobilityProfile.

Parameters:

Name	Type	Description	Default
mobility_profile_data	MobilityProfile	A dict describing the MobilityProfile.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_mobility_profile

update_mobility_profile(**kwargs: Unpack[UpdateMobilityProfile]) -> Dict[str, Any]

Update an existing MobilityProfile.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateMobilityProfile]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_mobility_profile

remove_mobility_profile(name: str) -> Dict[str, Any]

Remove a MobilityProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The MobilityProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_mobility_profile

list_mobility_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List MobilityProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_moh_audio_source

get_moh_audio_source(name: str) -> Dict[str, Any]

Retrieve a MohAudioSource by name.

Parameters:

Name	Type	Description	Default
name	str	The MohAudioSource name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

update_moh_audio_source

update_moh_audio_source(**kwargs: Unpack[UpdateMohAudioSource]) -> Dict[str, Any]

Update an existing MohAudioSource.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateMohAudioSource]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_moh_audio_source

remove_moh_audio_source(name: str) -> Dict[str, Any]

Remove a MohAudioSource by name.

Parameters:

Name	Type	Description	Default
name	str	The MohAudioSource name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_moh_audio_source

list_moh_audio_source(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List MohAudioSource objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_moh_server

get_moh_server(name: str) -> Dict[str, Any]

Retrieve a MohServer by name.

Parameters:

Name	Type	Description	Default
name	str	The MohServer name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

update_moh_server

update_moh_server(**kwargs: Unpack[UpdateMohServer]) -> Dict[str, Any]

Update an existing MohServer.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateMohServer]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_moh_server

list_moh_server(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List MohServer objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_mra_service_domain

get_mra_service_domain(name: str) -> Dict[str, Any]

Retrieve a MraServiceDomain by name.

Parameters:

Name	Type	Description	Default
name	str	The MraServiceDomain name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_mra_service_domain

add_mra_service_domain(mra_service_domain_data: MraServiceDomain) -> Dict[str, Any]

Add a new MraServiceDomain.

Parameters:

Name	Type	Description	Default
mra_service_domain_data	MraServiceDomain	A dict describing the MraServiceDomain.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_mra_service_domain

update_mra_service_domain(**kwargs: Unpack[UpdateMraServiceDomain]) -> Dict[str, Any]

Update an existing MraServiceDomain.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateMraServiceDomain]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_mra_service_domain

remove_mra_service_domain(name: str) -> Dict[str, Any]

Remove a MraServiceDomain by name.

Parameters:

Name	Type	Description	Default
name	str	The MraServiceDomain name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_mra_service_domain

list_mra_service_domain(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List MraServiceDomain objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_mtp

list_mtp(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List Mtp objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_mtp

apply_mtp(name: str) -> Dict[str, Any]

Apply configuration for a Mtp.

Parameters:

Name	Type	Description	Default
name	str	The Mtp name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_mtp

reset_mtp(name: str) -> Dict[str, Any]

Reset a Mtp.

Parameters:

Name	Type	Description	Default
name	str	The Mtp name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_mtp

restart_mtp(name: str) -> Dict[str, Any]

Restart a Mtp.

Parameters:

Name	Type	Description	Default
name	str	The Mtp name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_network_access_profile

get_network_access_profile(name: str) -> Dict[str, Any]

Retrieve a NetworkAccessProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The NetworkAccessProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_network_access_profile

add_network_access_profile(network_access_profile_data: NetworkAccessProfile) -> Dict[str, Any]

Add a new NetworkAccessProfile.

Parameters:

Name	Type	Description	Default
network_access_profile_data	NetworkAccessProfile	A dict describing the NetworkAccessProfile.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_network_access_profile

update_network_access_profile(**kwargs: Unpack[UpdateNetworkAccessProfile]) -> Dict[str, Any]

Update an existing NetworkAccessProfile.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateNetworkAccessProfile]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_network_access_profile

remove_network_access_profile(name: str) -> Dict[str, Any]

Remove a NetworkAccessProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The NetworkAccessProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_network_access_profile

list_network_access_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List NetworkAccessProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_phone

apply_phone(name: str) -> Dict[str, Any]

Apply configuration for a Phone.

Parameters:

Name	Type	Description	Default
name	str	The Phone name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_phone

reset_phone(name: str) -> Dict[str, Any]

Reset a Phone.

Parameters:

Name	Type	Description	Default
name	str	The Phone name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_phone

restart_phone(name: str) -> Dict[str, Any]

Restart a Phone.

Parameters:

Name	Type	Description	Default
name	str	The Phone name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_phone_button_template

list_phone_button_template(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List PhoneButtonTemplate objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_phone_button_template

apply_phone_button_template(name: str) -> Dict[str, Any]

Apply configuration for a PhoneButtonTemplate.

Parameters:

Name	Type	Description	Default
name	str	The PhoneButtonTemplate name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_phone_button_template

restart_phone_button_template(name: str) -> Dict[str, Any]

Restart a PhoneButtonTemplate.

Parameters:

Name	Type	Description	Default
name	str	The PhoneButtonTemplate name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_phone_ntp

update_phone_ntp(**kwargs: Unpack[UpdatePhoneNtp]) -> Dict[str, Any]

Update an existing PhoneNtp.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdatePhoneNtp]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_phone_ntp

list_phone_ntp(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List PhoneNtp objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_phone_security_profile

update_phone_security_profile(**kwargs: Unpack[UpdatePhoneSecurityProfile]) -> Dict[str, Any]

Update an existing PhoneSecurityProfile.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdatePhoneSecurityProfile]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_phone_security_profile

remove_phone_security_profile(name: str) -> Dict[str, Any]

Remove a PhoneSecurityProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The PhoneSecurityProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_phone_security_profile

list_phone_security_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List PhoneSecurityProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_phone_security_profile

apply_phone_security_profile(name: str) -> Dict[str, Any]

Apply configuration for a PhoneSecurityProfile.

Parameters:

Name	Type	Description	Default
name	str	The PhoneSecurityProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_phone_security_profile

reset_phone_security_profile(name: str) -> Dict[str, Any]

Reset a PhoneSecurityProfile.

Parameters:

Name	Type	Description	Default
name	str	The PhoneSecurityProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_physical_location

get_physical_location(name: str) -> Dict[str, Any]

Retrieve a PhysicalLocation by name.

Parameters:

Name	Type	Description	Default
name	str	The PhysicalLocation name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_physical_location

add_physical_location(physical_location_data: PhysicalLocation) -> Dict[str, Any]

Add a new PhysicalLocation.

Parameters:

Name	Type	Description	Default
physical_location_data	PhysicalLocation	A dict describing the PhysicalLocation.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_physical_location

update_physical_location(**kwargs: Unpack[UpdatePhysicalLocation]) -> Dict[str, Any]

Update an existing PhysicalLocation.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdatePhysicalLocation]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_physical_location

remove_physical_location(name: str) -> Dict[str, Any]

Remove a PhysicalLocation by name.

Parameters:

Name	Type	Description	Default
name	str	The PhysicalLocation name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_physical_location

list_physical_location(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List PhysicalLocation objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_presence_group

update_presence_group(**kwargs: Unpack[UpdatePresenceGroup]) -> Dict[str, Any]

Update an existing PresenceGroup.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdatePresenceGroup]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_presence_group

list_presence_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List PresenceGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_presence_redundancy_group

get_presence_redundancy_group(name: str) -> Dict[str, Any]

Retrieve a PresenceRedundancyGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The PresenceRedundancyGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_presence_redundancy_group

add_presence_redundancy_group(presence_redundancy_group_data: PresenceRedundancyGroup) -> Dict[str, Any]

Add a new PresenceRedundancyGroup.

Parameters:

Name	Type	Description	Default
presence_redundancy_group_data	PresenceRedundancyGroup	A dict describing the PresenceRedundancyGroup.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_presence_redundancy_group

update_presence_redundancy_group(**kwargs: Unpack[UpdatePresenceRedundancyGroup]) -> Dict[str, Any]

Update an existing PresenceRedundancyGroup.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdatePresenceRedundancyGroup]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_presence_redundancy_group

remove_presence_redundancy_group(name: str) -> Dict[str, Any]

Remove a PresenceRedundancyGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The PresenceRedundancyGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_presence_redundancy_group

list_presence_redundancy_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List PresenceRedundancyGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_process_node

get_process_node(name: str) -> Dict[str, Any]

Retrieve a ProcessNode by name.

Parameters:

Name	Type	Description	Default
name	str	The ProcessNode name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_process_node

add_process_node(process_node_data: ProcessNode) -> Dict[str, Any]

Add a new ProcessNode.

Parameters:

Name	Type	Description	Default
process_node_data	ProcessNode	A dict describing the ProcessNode.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_process_node

update_process_node(**kwargs: Unpack[UpdateProcessNode]) -> Dict[str, Any]

Update an existing ProcessNode.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateProcessNode]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_process_node

remove_process_node(name: str) -> Dict[str, Any]

Remove a ProcessNode by name.

Parameters:

Name	Type	Description	Default
name	str	The ProcessNode name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_process_node

list_process_node(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ProcessNode objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_process_node_service

get_process_node_service(**kwargs) -> Dict[str, Any]

Retrieve a ProcessNodeService.

Parameters:

Name	Type	Description	Default
**kwargs		Must include processNodeName + service, or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

update_process_node_service

update_process_node_service(**kwargs: Unpack[UpdateProcessNodeService]) -> Dict[str, Any]

Update an existing ProcessNodeService.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateProcessNodeService]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_process_node_service

list_process_node_service(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ProcessNodeService objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_recording_profile

get_recording_profile(name: str) -> Dict[str, Any]

Retrieve a RecordingProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The RecordingProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_recording_profile

add_recording_profile(recording_profile_data: RecordingProfile) -> Dict[str, Any]

Add a new RecordingProfile.

Parameters:

Name	Type	Description	Default
recording_profile_data	RecordingProfile	A dict describing the RecordingProfile.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_recording_profile

update_recording_profile(**kwargs: Unpack[UpdateRecordingProfile]) -> Dict[str, Any]

Update an existing RecordingProfile.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateRecordingProfile]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_recording_profile

remove_recording_profile(name: str) -> Dict[str, Any]

Remove a RecordingProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The RecordingProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_recording_profile

list_recording_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List RecordingProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_region

list_region(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List Region objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_region

apply_region(name: str) -> Dict[str, Any]

Apply configuration for a Region.

Parameters:

Name	Type	Description	Default
name	str	The Region name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_region

restart_region(name: str) -> Dict[str, Any]

Restart a Region.

Parameters:

Name	Type	Description	Default
name	str	The Region name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_remote_cluster

get_remote_cluster(cluster_id: str) -> Dict[str, Any]

Retrieve a RemoteCluster by clusterId.

Parameters:

Name	Type	Description	Default
cluster_id	str	The RemoteCluster clusterId.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_remote_cluster

add_remote_cluster(remote_cluster_data: RemoteCluster) -> Dict[str, Any]

Add a new RemoteCluster.

Parameters:

Name	Type	Description	Default
remote_cluster_data	RemoteCluster	A dict describing the RemoteCluster.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_remote_cluster

update_remote_cluster(**kwargs: Unpack[UpdateRemoteCluster]) -> Dict[str, Any]

Update an existing RemoteCluster.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateRemoteCluster]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_remote_cluster

remove_remote_cluster(cluster_id: str) -> Dict[str, Any]

Remove a RemoteCluster by clusterId.

Parameters:

Name	Type	Description	Default
cluster_id	str	The RemoteCluster clusterId.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_remote_cluster

list_remote_cluster(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List RemoteCluster objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_remote_destination

update_remote_destination(**kwargs: Unpack[UpdateRemoteDestination]) -> Dict[str, Any]

Update an existing RemoteDestination.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateRemoteDestination]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_remote_destination

list_remote_destination(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List RemoteDestination objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_remote_destination_profile

list_remote_destination_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List RemoteDestinationProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_resource_priority_namespace

get_resource_priority_namespace(name: str) -> Dict[str, Any]

Retrieve a ResourcePriorityNamespace by name.

Parameters:

Name	Type	Description	Default
name	str	The ResourcePriorityNamespace name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_resource_priority_namespace

add_resource_priority_namespace(resource_priority_namespace_data: ResourcePriorityNamespace) -> Dict[str, Any]

Add a new ResourcePriorityNamespace.

Parameters:

Name	Type	Description	Default
resource_priority_namespace_data	ResourcePriorityNamespace	A dict describing the ResourcePriorityNamespace.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_resource_priority_namespace

update_resource_priority_namespace(**kwargs: Unpack[UpdateResourcePriorityNamespace]) -> Dict[str, Any]

Update an existing ResourcePriorityNamespace.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateResourcePriorityNamespace]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_resource_priority_namespace

remove_resource_priority_namespace(name: str) -> Dict[str, Any]

Remove a ResourcePriorityNamespace by name.

Parameters:

Name	Type	Description	Default
name	str	The ResourcePriorityNamespace name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_resource_priority_namespace

list_resource_priority_namespace(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ResourcePriorityNamespace objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_resource_priority_namespace

apply_resource_priority_namespace(name: str) -> Dict[str, Any]

Apply configuration for a ResourcePriorityNamespace.

Parameters:

Name	Type	Description	Default
name	str	The ResourcePriorityNamespace name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_resource_priority_namespace

reset_resource_priority_namespace(name: str) -> Dict[str, Any]

Reset a ResourcePriorityNamespace.

Parameters:

Name	Type	Description	Default
name	str	The ResourcePriorityNamespace name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_resource_priority_namespace

restart_resource_priority_namespace(name: str) -> Dict[str, Any]

Restart a ResourcePriorityNamespace.

Parameters:

Name	Type	Description	Default
name	str	The ResourcePriorityNamespace name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_resource_priority_namespace_list

get_resource_priority_namespace_list(name: str) -> Dict[str, Any]

Retrieve a ResourcePriorityNamespaceList by name.

Parameters:

Name	Type	Description	Default
name	str	The ResourcePriorityNamespaceList name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_resource_priority_namespace_list

add_resource_priority_namespace_list(resource_priority_namespace_list_data: ResourcePriorityNamespaceList) -> Dict[str, Any]

Add a new ResourcePriorityNamespaceList.

Parameters:

Name	Type	Description	Default
resource_priority_namespace_list_data	ResourcePriorityNamespaceList	A dict describing the ResourcePriorityNamespaceList.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_resource_priority_namespace_list

update_resource_priority_namespace_list(**kwargs: Unpack[UpdateResourcePriorityNamespaceList]) -> Dict[str, Any]

Update an existing ResourcePriorityNamespaceList.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateResourcePriorityNamespaceList]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_resource_priority_namespace_list

remove_resource_priority_namespace_list(name: str) -> Dict[str, Any]

Remove a ResourcePriorityNamespaceList by name.

Parameters:

Name	Type	Description	Default
name	str	The ResourcePriorityNamespaceList name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_resource_priority_namespace_list

list_resource_priority_namespace_list(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ResourcePriorityNamespaceList objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_resource_priority_namespace_list

apply_resource_priority_namespace_list(name: str) -> Dict[str, Any]

Apply configuration for a ResourcePriorityNamespaceList.

Parameters:

Name	Type	Description	Default
name	str	The ResourcePriorityNamespaceList name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_resource_priority_namespace_list

reset_resource_priority_namespace_list(name: str) -> Dict[str, Any]

Reset a ResourcePriorityNamespaceList.

Parameters:

Name	Type	Description	Default
name	str	The ResourcePriorityNamespaceList name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_resource_priority_namespace_list

restart_resource_priority_namespace_list(name: str) -> Dict[str, Any]

Restart a ResourcePriorityNamespaceList.

Parameters:

Name	Type	Description	Default
name	str	The ResourcePriorityNamespaceList name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_route_filter

list_route_filter(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List RouteFilter objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_route_group

list_route_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List RouteGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_route_list

list_route_list(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List RouteList objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_route_list

apply_route_list(name: str) -> Dict[str, Any]

Apply configuration for a RouteList.

Parameters:

Name	Type	Description	Default
name	str	The RouteList name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_route_list

reset_route_list(name: str) -> Dict[str, Any]

Reset a RouteList.

Parameters:

Name	Type	Description	Default
name	str	The RouteList name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_route_partition

update_route_partition(**kwargs: Unpack[UpdateRoutePartition]) -> Dict[str, Any]

Update an existing RoutePartition.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateRoutePartition]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_route_partition

list_route_partition(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List RoutePartition objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_route_partition

apply_route_partition(name: str) -> Dict[str, Any]

Apply configuration for a RoutePartition.

Parameters:

Name	Type	Description	Default
name	str	The RoutePartition name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_route_partition

restart_route_partition(name: str) -> Dict[str, Any]

Restart a RoutePartition.

Parameters:

Name	Type	Description	Default
name	str	The RoutePartition name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_route_pattern

list_route_pattern(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List RoutePattern objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_sip_normalization_script

get_sip_normalization_script(name: str) -> Dict[str, Any]

Retrieve a SIPNormalizationScript by name.

Parameters:

Name	Type	Description	Default
name	str	The SIPNormalizationScript name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_sip_normalization_script

add_sip_normalization_script(sip_normalization_script_data: SIPNormalizationScript) -> Dict[str, Any]

Add a new SIPNormalizationScript.

Parameters:

Name	Type	Description	Default
sip_normalization_script_data	SIPNormalizationScript	A dict describing the SIPNormalizationScript.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_sip_normalization_script

update_sip_normalization_script(**kwargs: Unpack[UpdateSIPNormalizationScript]) -> Dict[str, Any]

Update an existing SIPNormalizationScript.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateSIPNormalizationScript]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_sip_normalization_script

remove_sip_normalization_script(name: str) -> Dict[str, Any]

Remove a SIPNormalizationScript by name.

Parameters:

Name	Type	Description	Default
name	str	The SIPNormalizationScript name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_sip_normalization_script

list_sip_normalization_script(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List SIPNormalizationScript objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_snmp_community_string

get_snmp_community_string(name: str) -> Dict[str, Any]

Retrieve a SNMPCommunityString by name.

Parameters:

Name	Type	Description	Default
name	str	The SNMPCommunityString name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_snmp_community_string

add_snmp_community_string(snmp_community_string_data: RCommunityString) -> Dict[str, Any]

Add a new SNMPCommunityString.

Parameters:

Name	Type	Description	Default
snmp_community_string_data	RCommunityString	A dict describing the SNMPCommunityString.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_snmp_community_string

update_snmp_community_string(**kwargs: Unpack[UpdateSNMPCommunityString]) -> Dict[str, Any]

Update an existing SNMPCommunityString.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateSNMPCommunityString]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_snmp_community_string

remove_snmp_community_string(name: str) -> Dict[str, Any]

Remove a SNMPCommunityString by name.

Parameters:

Name	Type	Description	Default
name	str	The SNMPCommunityString name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_snmp_user

get_snmp_user(name: str) -> Dict[str, Any]

Retrieve a SNMPUser by name.

Parameters:

Name	Type	Description	Default
name	str	The SNMPUser name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_snmp_user

add_snmp_user(snmp_user_data: RSNMPUser) -> Dict[str, Any]

Add a new SNMPUser.

Parameters:

Name	Type	Description	Default
snmp_user_data	RSNMPUser	A dict describing the SNMPUser.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_snmp_user

update_snmp_user(**kwargs: Unpack[UpdateSNMPUser]) -> Dict[str, Any]

Update an existing SNMPUser.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateSNMPUser]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_snmp_user

remove_snmp_user(name: str) -> Dict[str, Any]

Remove a SNMPUser by name.

Parameters:

Name	Type	Description	Default
name	str	The SNMPUser name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_saf_ccd_purge_block_learned_routes

get_saf_ccd_purge_block_learned_routes(**kwargs) -> Dict[str, Any]

Retrieve a SafCcdPurgeBlockLearnedRoutes.

Parameters:

Name	Type	Description	Default
**kwargs		Must include learnedPattern (or learnedPatternPrefix), callControlIdentity, and ipAddress; or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_saf_ccd_purge_block_learned_routes

add_saf_ccd_purge_block_learned_routes(saf_ccd_purge_block_learned_routes_data: SafCcdPurgeBlockLearnedRoutes) -> Dict[str, Any]

Add a new SafCcdPurgeBlockLearnedRoutes.

Parameters:

Name	Type	Description	Default
saf_ccd_purge_block_learned_routes_data	SafCcdPurgeBlockLearnedRoutes	A dict describing the SafCcdPurgeBlockLearnedRoutes.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_saf_ccd_purge_block_learned_routes

update_saf_ccd_purge_block_learned_routes(**kwargs: Unpack[UpdateSafCcdPurgeBlockLearnedRoutes]) -> Dict[str, Any]

Update an existing SafCcdPurgeBlockLearnedRoutes.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateSafCcdPurgeBlockLearnedRoutes]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_saf_ccd_purge_block_learned_routes

remove_saf_ccd_purge_block_learned_routes(**kwargs) -> Dict[str, Any]

Remove a SafCcdPurgeBlockLearnedRoutes.

Parameters:

Name	Type	Description	Default
**kwargs		Must include learnedPattern (or learnedPatternPrefix), callControlIdentity, and ipAddress; or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_saf_ccd_purge_block_learned_routes

list_saf_ccd_purge_block_learned_routes(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List SafCcdPurgeBlockLearnedRoutes objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_saf_forwarder

get_saf_forwarder(name: str) -> Dict[str, Any]

Retrieve a SafForwarder by name.

Parameters:

Name	Type	Description	Default
name	str	The SafForwarder name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_saf_forwarder

add_saf_forwarder(saf_forwarder_data: SafForwarder) -> Dict[str, Any]

Add a new SafForwarder.

Parameters:

Name	Type	Description	Default
saf_forwarder_data	SafForwarder	A dict describing the SafForwarder.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_saf_forwarder

update_saf_forwarder(**kwargs: Unpack[UpdateSafForwarder]) -> Dict[str, Any]

Update an existing SafForwarder.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateSafForwarder]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_saf_forwarder

remove_saf_forwarder(name: str) -> Dict[str, Any]

Remove a SafForwarder by name.

Parameters:

Name	Type	Description	Default
name	str	The SafForwarder name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_saf_forwarder

list_saf_forwarder(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List SafForwarder objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_saf_security_profile

get_saf_security_profile(name: str) -> Dict[str, Any]

Retrieve a SafSecurityProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The SafSecurityProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_saf_security_profile

add_saf_security_profile(saf_security_profile_data: SafSecurityProfile) -> Dict[str, Any]

Add a new SafSecurityProfile.

Parameters:

Name	Type	Description	Default
saf_security_profile_data	SafSecurityProfile	A dict describing the SafSecurityProfile.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_saf_security_profile

update_saf_security_profile(**kwargs: Unpack[UpdateSafSecurityProfile]) -> Dict[str, Any]

Update an existing SafSecurityProfile.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateSafSecurityProfile]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_saf_security_profile

remove_saf_security_profile(name: str) -> Dict[str, Any]

Remove a SafSecurityProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The SafSecurityProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_saf_security_profile

list_saf_security_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List SafSecurityProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_sdp_transparency_profile

get_sdp_transparency_profile(name: str) -> Dict[str, Any]

Retrieve a SdpTransparencyProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The SdpTransparencyProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_sdp_transparency_profile

add_sdp_transparency_profile(sdp_transparency_profile_data: SdpTransparencyProfile) -> Dict[str, Any]

Add a new SdpTransparencyProfile.

Parameters:

Name	Type	Description	Default
sdp_transparency_profile_data	SdpTransparencyProfile	A dict describing the SdpTransparencyProfile.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_sdp_transparency_profile

update_sdp_transparency_profile(**kwargs: Unpack[UpdateSdpTransparencyProfile]) -> Dict[str, Any]

Update an existing SdpTransparencyProfile.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateSdpTransparencyProfile]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_sdp_transparency_profile

remove_sdp_transparency_profile(name: str) -> Dict[str, Any]

Remove a SdpTransparencyProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The SdpTransparencyProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_sdp_transparency_profile

list_sdp_transparency_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List SdpTransparencyProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_service_profile

list_service_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List ServiceProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_sip_dial_rules

get_sip_dial_rules(name: str) -> Dict[str, Any]

Retrieve a SipDialRules by name.

Parameters:

Name	Type	Description	Default
name	str	The SipDialRules name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_sip_dial_rules

add_sip_dial_rules(sip_dial_rules_data: SipDialRules) -> Dict[str, Any]

Add a new SipDialRules.

Parameters:

Name	Type	Description	Default
sip_dial_rules_data	SipDialRules	A dict describing the SipDialRules.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_sip_dial_rules

update_sip_dial_rules(**kwargs: Unpack[UpdateSipDialRules]) -> Dict[str, Any]

Update an existing SipDialRules.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateSipDialRules]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_sip_dial_rules

remove_sip_dial_rules(name: str) -> Dict[str, Any]

Remove a SipDialRules by name.

Parameters:

Name	Type	Description	Default
name	str	The SipDialRules name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_sip_dial_rules

list_sip_dial_rules(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List SipDialRules objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_sip_profile

list_sip_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List SipProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_sip_profile

apply_sip_profile(name: str) -> Dict[str, Any]

Apply configuration for a SipProfile.

Parameters:

Name	Type	Description	Default
name	str	The SipProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_sip_profile

restart_sip_profile(name: str) -> Dict[str, Any]

Restart a SipProfile.

Parameters:

Name	Type	Description	Default
name	str	The SipProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_sip_realm

get_sip_realm(realm: str) -> Dict[str, Any]

Retrieve a SipRealm by realm.

Parameters:

Name	Type	Description	Default
realm	str	The SipRealm realm.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_sip_realm

add_sip_realm(sip_realm_data: SipRealm) -> Dict[str, Any]

Add a new SipRealm.

Parameters:

Name	Type	Description	Default
sip_realm_data	SipRealm	A dict describing the SipRealm.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_sip_realm

update_sip_realm(**kwargs: Unpack[UpdateSipRealm]) -> Dict[str, Any]

Update an existing SipRealm.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateSipRealm]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_sip_realm

remove_sip_realm(realm: str) -> Dict[str, Any]

Remove a SipRealm by realm.

Parameters:

Name	Type	Description	Default
realm	str	The SipRealm realm.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_sip_realm

list_sip_realm(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List SipRealm objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_sip_route_pattern

list_sip_route_pattern(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List SipRoutePattern objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_sip_trunk

list_sip_trunk(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List SipTrunk objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_sip_trunk

reset_sip_trunk(name: str) -> Dict[str, Any]

Reset a SipTrunk.

Parameters:

Name	Type	Description	Default
name	str	The SipTrunk name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_sip_trunk

restart_sip_trunk(name: str) -> Dict[str, Any]

Restart a SipTrunk.

Parameters:

Name	Type	Description	Default
name	str	The SipTrunk name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_sip_trunk_security_profile

update_sip_trunk_security_profile(**kwargs: Unpack[UpdateSipTrunkSecurityProfile]) -> Dict[str, Any]

Update an existing SipTrunkSecurityProfile.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateSipTrunkSecurityProfile]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_sip_trunk_security_profile

list_sip_trunk_security_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List SipTrunkSecurityProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_sip_trunk_security_profile

apply_sip_trunk_security_profile(name: str) -> Dict[str, Any]

Apply configuration for a SipTrunkSecurityProfile.

Parameters:

Name	Type	Description	Default
name	str	The SipTrunkSecurityProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_sip_trunk_security_profile

reset_sip_trunk_security_profile(name: str) -> Dict[str, Any]

Reset a SipTrunkSecurityProfile.

Parameters:

Name	Type	Description	Default
name	str	The SipTrunkSecurityProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_soft_key_template

update_soft_key_template(**kwargs: Unpack[UpdateSoftKeyTemplate]) -> Dict[str, Any]

Update an existing SoftKeyTemplate.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateSoftKeyTemplate]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_soft_key_template

list_soft_key_template(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List SoftKeyTemplate objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_soft_key_template

apply_soft_key_template(name: str) -> Dict[str, Any]

Apply configuration for a SoftKeyTemplate.

Parameters:

Name	Type	Description	Default
name	str	The SoftKeyTemplate name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_soft_key_template

restart_soft_key_template(name: str) -> Dict[str, Any]

Restart a SoftKeyTemplate.

Parameters:

Name	Type	Description	Default
name	str	The SoftKeyTemplate name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_srst

list_srst(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List Srst objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_srst

apply_srst(name: str) -> Dict[str, Any]

Apply configuration for a Srst.

Parameters:

Name	Type	Description	Default
name	str	The Srst name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_srst

reset_srst(name: str) -> Dict[str, Any]

Reset a Srst.

Parameters:

Name	Type	Description	Default
name	str	The Srst name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_srst

restart_srst(name: str) -> Dict[str, Any]

Restart a Srst.

Parameters:

Name	Type	Description	Default
name	str	The Srst name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_time_period

get_time_period(name: str) -> Dict[str, Any]

Retrieve a TimePeriod by name.

Parameters:

Name	Type	Description	Default
name	str	The TimePeriod name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_time_period

add_time_period(time_period_data: TimePeriod) -> Dict[str, Any]

Add a new TimePeriod.

Parameters:

Name	Type	Description	Default
time_period_data	TimePeriod	A dict describing the TimePeriod.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_time_period

update_time_period(**kwargs: Unpack[UpdateTimePeriod]) -> Dict[str, Any]

Update an existing TimePeriod.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateTimePeriod]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_time_period

remove_time_period(name: str) -> Dict[str, Any]

Remove a TimePeriod by name.

Parameters:

Name	Type	Description	Default
name	str	The TimePeriod name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_time_period

list_time_period(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List TimePeriod objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_time_schedule

get_time_schedule(name: str) -> Dict[str, Any]

Retrieve a TimeSchedule by name.

Parameters:

Name	Type	Description	Default
name	str	The TimeSchedule name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_time_schedule

add_time_schedule(time_schedule_data: TimeSchedule) -> Dict[str, Any]

Add a new TimeSchedule.

Parameters:

Name	Type	Description	Default
time_schedule_data	TimeSchedule	A dict describing the TimeSchedule.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_time_schedule

update_time_schedule(**kwargs: Unpack[UpdateTimeSchedule]) -> Dict[str, Any]

Update an existing TimeSchedule.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateTimeSchedule]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_time_schedule

remove_time_schedule(name: str) -> Dict[str, Any]

Remove a TimeSchedule by name.

Parameters:

Name	Type	Description	Default
name	str	The TimeSchedule name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_time_schedule

list_time_schedule(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List TimeSchedule objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_tod_access

get_tod_access(name: str) -> Dict[str, Any]

Retrieve a TodAccess by name.

Parameters:

Name	Type	Description	Default
name	str	The TodAccess name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_tod_access

add_tod_access(tod_access_data: TodAccess) -> Dict[str, Any]

Add a new TodAccess.

Parameters:

Name	Type	Description	Default
tod_access_data	TodAccess	A dict describing the TodAccess.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_tod_access

update_tod_access(**kwargs: Unpack[UpdateTodAccess]) -> Dict[str, Any]

Update an existing TodAccess.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateTodAccess]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_tod_access

remove_tod_access(name: str) -> Dict[str, Any]

Remove a TodAccess by name.

Parameters:

Name	Type	Description	Default
name	str	The TodAccess name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_tod_access

list_tod_access(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List TodAccess objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_trans_pattern

list_trans_pattern(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List TransPattern objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_transcoder

list_transcoder(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List Transcoder objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_transcoder

apply_transcoder(name: str) -> Dict[str, Any]

Apply configuration for a Transcoder.

Parameters:

Name	Type	Description	Default
name	str	The Transcoder name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_transcoder

reset_transcoder(name: str) -> Dict[str, Any]

Reset a Transcoder.

Parameters:

Name	Type	Description	Default
name	str	The Transcoder name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_transformation_profile

get_transformation_profile(name: str) -> Dict[str, Any]

Retrieve a TransformationProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The TransformationProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_transformation_profile

add_transformation_profile(transformation_profile_data: TransformationProfile) -> Dict[str, Any]

Add a new TransformationProfile.

Parameters:

Name	Type	Description	Default
transformation_profile_data	TransformationProfile	A dict describing the TransformationProfile.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_transformation_profile

update_transformation_profile(**kwargs: Unpack[UpdateTransformationProfile]) -> Dict[str, Any]

Update an existing TransformationProfile.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateTransformationProfile]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_transformation_profile

remove_transformation_profile(name: str) -> Dict[str, Any]

Remove a TransformationProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The TransformationProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_transformation_profile

list_transformation_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List TransformationProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_uc_service

list_uc_service(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List UcService objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_uc_service

apply_uc_service(name: str) -> Dict[str, Any]

Apply configuration for a UcService.

Parameters:

Name	Type	Description	Default
name	str	The UcService name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_uc_service

reset_uc_service(name: str) -> Dict[str, Any]

Reset a UcService.

Parameters:

Name	Type	Description	Default
name	str	The UcService name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_uc_service

restart_uc_service(name: str) -> Dict[str, Any]

Restart a UcService.

Parameters:

Name	Type	Description	Default
name	str	The UcService name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

add_units_to_gateway

add_units_to_gateway(units_to_gateway_data: UnitsToGateway) -> Dict[str, Any]

Add a new UnitsToGateway.

Parameters:

Name	Type	Description	Default
units_to_gateway_data	UnitsToGateway	A dict describing the UnitsToGateway.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

remove_units_to_gateway

remove_units_to_gateway(name: str) -> Dict[str, Any]

Remove a UnitsToGateway by name.

Parameters:

Name	Type	Description	Default
name	str	The UnitsToGateway name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

get_universal_device_template

get_universal_device_template(name: str) -> Dict[str, Any]

Retrieve a UniversalDeviceTemplate by name.

Parameters:

Name	Type	Description	Default
name	str	The UniversalDeviceTemplate name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_universal_device_template

add_universal_device_template(universal_device_template_data: UniversalDeviceTemplate) -> Dict[str, Any]

Add a new UniversalDeviceTemplate.

Parameters:

Name	Type	Description	Default
universal_device_template_data	UniversalDeviceTemplate	A dict describing the UniversalDeviceTemplate.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_universal_device_template

update_universal_device_template(**kwargs: Unpack[UpdateUniversalDeviceTemplate]) -> Dict[str, Any]

Update an existing UniversalDeviceTemplate.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateUniversalDeviceTemplate]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_universal_device_template

remove_universal_device_template(name: str) -> Dict[str, Any]

Remove a UniversalDeviceTemplate by name.

Parameters:

Name	Type	Description	Default
name	str	The UniversalDeviceTemplate name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_universal_device_template

list_universal_device_template(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List UniversalDeviceTemplate objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_universal_line_template

get_universal_line_template(name: str) -> Dict[str, Any]

Retrieve a UniversalLineTemplate by name.

Parameters:

Name	Type	Description	Default
name	str	The UniversalLineTemplate name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_universal_line_template

add_universal_line_template(universal_line_template_data: UniversalLineTemplate) -> Dict[str, Any]

Add a new UniversalLineTemplate.

Parameters:

Name	Type	Description	Default
universal_line_template_data	UniversalLineTemplate	A dict describing the UniversalLineTemplate.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_universal_line_template

update_universal_line_template(**kwargs: Unpack[UpdateUniversalLineTemplate]) -> Dict[str, Any]

Update an existing UniversalLineTemplate.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateUniversalLineTemplate]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_universal_line_template

remove_universal_line_template(name: str) -> Dict[str, Any]

Remove a UniversalLineTemplate by name.

Parameters:

Name	Type	Description	Default
name	str	The UniversalLineTemplate name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_universal_line_template

list_universal_line_template(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List UniversalLineTemplate objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

add_user

add_user(user_data: User) -> Dict[str, Any]

Add a new end user.

Parameters:

Name	Type	Description	Default
user_data	User	A dict describing the user. Required keys: userid, lastName, presenceGroupName. Example:: { "userid": "jsmith", "firstName": "John", "lastName": "Smith", "password": "changeme", "pin": "12345", "presenceGroupName": "Standard Presence group", }	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

remove_user

remove_user(userid: str) -> Dict[str, Any]

Remove an end user by userid.

Parameters:

Name	Type	Description	Default
userid	str	The user ID to remove.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_user_group

list_user_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List UserGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_user_profile_provision

get_user_profile_provision(name: str) -> Dict[str, Any]

Retrieve a UserProfileProvision by name.

Parameters:

Name	Type	Description	Default
name	str	The UserProfileProvision name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_user_profile_provision

add_user_profile_provision(user_profile_provision_data: UserProfileProvision) -> Dict[str, Any]

Add a new UserProfileProvision.

Parameters:

Name	Type	Description	Default
user_profile_provision_data	UserProfileProvision	A dict describing the UserProfileProvision.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_user_profile_provision

update_user_profile_provision(**kwargs: Unpack[UpdateUserProfileProvision]) -> Dict[str, Any]

Update an existing UserProfileProvision.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateUserProfileProvision]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_user_profile_provision

remove_user_profile_provision(name: str) -> Dict[str, Any]

Remove a UserProfileProvision by name.

Parameters:

Name	Type	Description	Default
name	str	The UserProfileProvision name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_user_profile_provision

list_user_profile_provision(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List UserProfileProvision objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_vg224

get_vg224(domain_name: str = '', **kwargs) -> Dict[str, Any]

Retrieve a Vg224 by domainName.

Parameters:

Name	Type	Description	Default
domain_name	str	The Vg224 domain name.	''
**kwargs		Additional keyword arguments (e.g., uuid).	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_vg224

add_vg224(vg224_data: Vg224) -> Dict[str, Any]

Add a new Vg224.

Parameters:

Name	Type	Description	Default
vg224_data	Vg224	A dict describing the Vg224.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_vg224

update_vg224(**kwargs: Unpack[UpdateVg224]) -> Dict[str, Any]

Update an existing Vg224.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateVg224]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_vg224

remove_vg224(domain_name: str = '', **kwargs) -> Dict[str, Any]

Remove a Vg224 by domainName.

Parameters:

Name	Type	Description	Default
domain_name	str	The Vg224 domain name.	''
**kwargs		Additional keyword arguments (e.g., uuid).	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

reset_vg224

reset_vg224(name: str) -> Dict[str, Any]

Reset a Vg224.

Parameters:

Name	Type	Description	Default
name	str	The Vg224 name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_vg224

restart_vg224(name: str) -> Dict[str, Any]

Restart a Vg224.

Parameters:

Name	Type	Description	Default
name	str	The Vg224 name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_voh_server

get_voh_server(name: str) -> Dict[str, Any]

Retrieve a VohServer by name.

Parameters:

Name	Type	Description	Default
name	str	The VohServer name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_voh_server

add_voh_server(voh_server_data: VohServer) -> Dict[str, Any]

Add a new VohServer.

Parameters:

Name	Type	Description	Default
voh_server_data	VohServer	A dict describing the VohServer.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_voh_server

update_voh_server(**kwargs: Unpack[UpdateVohServer]) -> Dict[str, Any]

Update an existing VohServer.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateVohServer]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_voh_server

remove_voh_server(name: str) -> Dict[str, Any]

Remove a VohServer by name.

Parameters:

Name	Type	Description	Default
name	str	The VohServer name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_voh_server

list_voh_server(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List VohServer objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_voice_mail_pilot

update_voice_mail_pilot(**kwargs: Unpack[UpdateVoiceMailPilot]) -> Dict[str, Any]

Update an existing VoiceMailPilot.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateVoiceMailPilot]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_voice_mail_pilot

list_voice_mail_pilot(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List VoiceMailPilot objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_voice_mail_port

update_voice_mail_port(**kwargs: Unpack[UpdateVoiceMailPort]) -> Dict[str, Any]

Update an existing VoiceMailPort.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateVoiceMailPort]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_voice_mail_port

list_voice_mail_port(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List VoiceMailPort objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_voice_mail_port

apply_voice_mail_port(name: str) -> Dict[str, Any]

Apply configuration for a VoiceMailPort.

Parameters:

Name	Type	Description	Default
name	str	The VoiceMailPort name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_voice_mail_port

reset_voice_mail_port(name: str) -> Dict[str, Any]

Reset a VoiceMailPort.

Parameters:

Name	Type	Description	Default
name	str	The VoiceMailPort name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_voice_mail_port

restart_voice_mail_port(name: str) -> Dict[str, Any]

Restart a VoiceMailPort.

Parameters:

Name	Type	Description	Default
name	str	The VoiceMailPort name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_voice_mail_profile

update_voice_mail_profile(**kwargs: Unpack[UpdateVoiceMailProfile]) -> Dict[str, Any]

Update an existing VoiceMailProfile.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateVoiceMailProfile]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_voice_mail_profile

list_voice_mail_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List VoiceMailProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_voice_mail_profile

apply_voice_mail_profile(name: str) -> Dict[str, Any]

Apply configuration for a VoiceMailProfile.

Parameters:

Name	Type	Description	Default
name	str	The VoiceMailProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_voice_mail_profile

reset_voice_mail_profile(name: str) -> Dict[str, Any]

Reset a VoiceMailProfile.

Parameters:

Name	Type	Description	Default
name	str	The VoiceMailProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_voice_mail_profile

restart_voice_mail_profile(name: str) -> Dict[str, Any]

Restart a VoiceMailProfile.

Parameters:

Name	Type	Description	Default
name	str	The VoiceMailProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_vpn_gateway

get_vpn_gateway(name: str) -> Dict[str, Any]

Retrieve a VpnGateway by name.

Parameters:

Name	Type	Description	Default
name	str	The VpnGateway name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_vpn_gateway

add_vpn_gateway(vpn_gateway_data: VpnGateway) -> Dict[str, Any]

Add a new VpnGateway.

Parameters:

Name	Type	Description	Default
vpn_gateway_data	VpnGateway	A dict describing the VpnGateway.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_vpn_gateway

update_vpn_gateway(**kwargs: Unpack[UpdateVpnGateway]) -> Dict[str, Any]

Update an existing VpnGateway.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateVpnGateway]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_vpn_gateway

remove_vpn_gateway(name: str) -> Dict[str, Any]

Remove a VpnGateway by name.

Parameters:

Name	Type	Description	Default
name	str	The VpnGateway name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_vpn_gateway

list_vpn_gateway(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List VpnGateway objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_vpn_group

get_vpn_group(name: str) -> Dict[str, Any]

Retrieve a VpnGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The VpnGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_vpn_group

add_vpn_group(vpn_group_data: VpnGroup) -> Dict[str, Any]

Add a new VpnGroup.

Parameters:

Name	Type	Description	Default
vpn_group_data	VpnGroup	A dict describing the VpnGroup.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_vpn_group

update_vpn_group(**kwargs: Unpack[UpdateVpnGroup]) -> Dict[str, Any]

Update an existing VpnGroup.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateVpnGroup]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_vpn_group

remove_vpn_group(name: str) -> Dict[str, Any]

Remove a VpnGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The VpnGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_vpn_group

list_vpn_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List VpnGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_vpn_profile

get_vpn_profile(name: str) -> Dict[str, Any]

Retrieve a VpnProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The VpnProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_vpn_profile

add_vpn_profile(vpn_profile_data: VpnProfile) -> Dict[str, Any]

Add a new VpnProfile.

Parameters:

Name	Type	Description	Default
vpn_profile_data	VpnProfile	A dict describing the VpnProfile.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_vpn_profile

update_vpn_profile(**kwargs: Unpack[UpdateVpnProfile]) -> Dict[str, Any]

Update an existing VpnProfile.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateVpnProfile]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_vpn_profile

remove_vpn_profile(name: str) -> Dict[str, Any]

Remove a VpnProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The VpnProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_vpn_profile

list_vpn_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List VpnProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_wlan_profile

get_wlan_profile(name: str) -> Dict[str, Any]

Retrieve a WLANProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The WLANProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_wlan_profile

add_wlan_profile(wlan_profile_data: WLANProfile) -> Dict[str, Any]

Add a new WLANProfile.

Parameters:

Name	Type	Description	Default
wlan_profile_data	WLANProfile	A dict describing the WLANProfile.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_wlan_profile

update_wlan_profile(**kwargs: Unpack[UpdateWLANProfile]) -> Dict[str, Any]

Update an existing WLANProfile.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateWLANProfile]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_wlan_profile

remove_wlan_profile(name: str) -> Dict[str, Any]

Remove a WLANProfile by name.

Parameters:

Name	Type	Description	Default
name	str	The WLANProfile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_wlan_profile

list_wlan_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List WLANProfile objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_wifi_hotspot

get_wifi_hotspot(name: str) -> Dict[str, Any]

Retrieve a WifiHotspot by name.

Parameters:

Name	Type	Description	Default
name	str	The WifiHotspot name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_wifi_hotspot

add_wifi_hotspot(wifi_hotspot_data: WifiHotspot) -> Dict[str, Any]

Add a new WifiHotspot.

Parameters:

Name	Type	Description	Default
wifi_hotspot_data	WifiHotspot	A dict describing the WifiHotspot.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_wifi_hotspot

update_wifi_hotspot(**kwargs: Unpack[UpdateWifiHotspot]) -> Dict[str, Any]

Update an existing WifiHotspot.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateWifiHotspot]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_wifi_hotspot

remove_wifi_hotspot(name: str) -> Dict[str, Any]

Remove a WifiHotspot by name.

Parameters:

Name	Type	Description	Default
name	str	The WifiHotspot name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_wifi_hotspot

list_wifi_hotspot(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List WifiHotspot objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_wireless_access_point_controllers

get_wireless_access_point_controllers(name: str) -> Dict[str, Any]

Retrieve a WirelessAccessPointControllers by name.

Parameters:

Name	Type	Description	Default
name	str	The WirelessAccessPointControllers name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_wireless_access_point_controllers

add_wireless_access_point_controllers(wireless_access_point_controllers_data: WirelessAccessPointControllers) -> Dict[str, Any]

Add a new WirelessAccessPointControllers.

Parameters:

Name	Type	Description	Default
wireless_access_point_controllers_data	WirelessAccessPointControllers	A dict describing the WirelessAccessPointControllers.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_wireless_access_point_controllers

update_wireless_access_point_controllers(**kwargs: Unpack[UpdateWirelessAccessPointControllers]) -> Dict[str, Any]

Update an existing WirelessAccessPointControllers.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateWirelessAccessPointControllers]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_wireless_access_point_controllers

remove_wireless_access_point_controllers(name: str) -> Dict[str, Any]

Remove a WirelessAccessPointControllers by name.

Parameters:

Name	Type	Description	Default
name	str	The WirelessAccessPointControllers name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_wireless_access_point_controllers

list_wireless_access_point_controllers(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List WirelessAccessPointControllers objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_wlan_profile_group

get_wlan_profile_group(name: str) -> Dict[str, Any]

Retrieve a WlanProfileGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The WlanProfileGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

add_wlan_profile_group

add_wlan_profile_group(wlan_profile_group_data: WlanProfileGroup) -> Dict[str, Any]

Add a new WlanProfileGroup.

Parameters:

Name	Type	Description	Default
wlan_profile_group_data	WlanProfileGroup	A dict describing the WlanProfileGroup.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_wlan_profile_group

update_wlan_profile_group(**kwargs: Unpack[UpdateWlanProfileGroup]) -> Dict[str, Any]

Update an existing WlanProfileGroup.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateWlanProfileGroup]	Fields to update. Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

remove_wlan_profile_group

remove_wlan_profile_group(name: str) -> Dict[str, Any]

Remove a WlanProfileGroup by name.

Parameters:

Name	Type	Description	Default
name	str	The WlanProfileGroup name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If not found.
AXLError	On other AXL faults.

list_wlan_profile_group

list_wlan_profile_group(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List WlanProfileGroup objects matching search criteria.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Dict of field names to search patterns. Uses SQL LIKE syntax (% as wildcard).	None
returned_tags	Optional[Dict[str, str]]	Dict of field names to return.	None
**kwargs		Additional arguments passed to the AXL call.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_aar_group_matrix

update_aar_group_matrix(**kwargs: Unpack[UpdateAarGroupMatrix]) -> Dict[str, Any]

Update AarGroupMatrix configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateAarGroupMatrix]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_annunciator

get_annunciator(name: str = '', **kwargs) -> Dict[str, Any]

Retrieve Annunciator configuration.

Parameters:

Name	Type	Description	Default
name	str	The annunciator name.	''
**kwargs		Additional fields (e.g. uuid, returnedTags).	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLNotFoundError	If the annunciator is not found.
AXLError	On AXL faults.

update_annunciator

update_annunciator(**kwargs: Unpack[UpdateAnnunciator]) -> Dict[str, Any]

Update Annunciator configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateAnnunciator]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_call_manager

get_call_manager(name: str) -> Dict[str, Any]

Retrieve CallManager by name.

Parameters:

Name	Type	Description	Default
name	str	The CallManager name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_call_manager

update_call_manager(**kwargs: Unpack[UpdateCallManager]) -> Dict[str, Any]

Update CallManager configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCallManager]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_call_manager

list_call_manager(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List CallManager objects.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Search filter dict.	None
returned_tags	Optional[Dict[str, str]]	Fields to return.	None
**kwargs		Additional arguments.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

apply_call_manager

apply_call_manager(name: str) -> Dict[str, Any]

Apply configuration for CallManager.

Parameters:

Name	Type	Description	Default
name	str	The CallManager name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_call_manager

reset_call_manager(name: str) -> Dict[str, Any]

Reset CallManager.

Parameters:

Name	Type	Description	Default
name	str	The CallManager name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_call_manager

restart_call_manager(name: str) -> Dict[str, Any]

Restart CallManager.

Parameters:

Name	Type	Description	Default
name	str	The CallManager name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ccd_feature_config

get_ccd_feature_config(**kwargs) -> Dict[str, Any]

Retrieve CcdFeatureConfig configuration.

Parameters:

Name	Type	Description	Default
**kwargs		Keyword arguments passed to the WSDL operation. Requires paramName and returnedTags.	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ccd_feature_config

update_ccd_feature_config(**kwargs: Unpack[UpdateCcdFeatureConfig]) -> Dict[str, Any]

Update CcdFeatureConfig configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCcdFeatureConfig]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_cisco_cloud_onboarding

update_cisco_cloud_onboarding(**kwargs: Unpack[UpdateCiscoCloudOnboarding]) -> Dict[str, Any]

Update CiscoCloudOnboarding configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCiscoCloudOnboarding]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_device_defaults

get_device_defaults(**kwargs) -> Dict[str, Any]

Retrieve DeviceDefaults configuration.

Parameters:

Name	Type	Description	Default
**kwargs		Must include Model + Protocol, or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_device_defaults

update_device_defaults(**kwargs: Unpack[UpdateDeviceDefaults]) -> Dict[str, Any]

Update DeviceDefaults configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateDeviceDefaults]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_emcc_feature_config

get_emcc_feature_config(**kwargs) -> Dict[str, Any]

Retrieve EmccFeatureConfig configuration.

Parameters:

Name	Type	Description	Default
**kwargs		Must include parameterName; or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_emcc_feature_config

update_emcc_feature_config(**kwargs: Unpack[UpdateEmccFeatureConfig]) -> Dict[str, Any]

Update EmccFeatureConfig configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateEmccFeatureConfig]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

reset_enterprise_parameters

reset_enterprise_parameters() -> Dict[str, Any]

Reset EnterpriseParameters.

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

restart_enterprise_parameters

restart_enterprise_parameters() -> Dict[str, Any]

Restart EnterpriseParameters.

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_enterprise_phone_config

get_enterprise_phone_config() -> Dict[str, Any]

Retrieve EnterprisePhoneConfig configuration.

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_enterprise_phone_config

update_enterprise_phone_config(**kwargs: Unpack[UpdateEnterprisePhoneConfig]) -> Dict[str, Any]

Update EnterprisePhoneConfig configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateEnterprisePhoneConfig]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_fallback_feature_config

get_fallback_feature_config() -> Dict[str, Any]

Retrieve FallbackFeatureConfig configuration.

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_fallback_feature_config

update_fallback_feature_config(**kwargs: Unpack[UpdateFallbackFeatureConfig]) -> Dict[str, Any]

Update FallbackFeatureConfig configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateFallbackFeatureConfig]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_fixed_moh_audio_source

get_fixed_moh_audio_source(name: str) -> Dict[str, Any]

Retrieve FixedMohAudioSource by name.

Parameters:

Name	Type	Description	Default
name	str	The FixedMohAudioSource name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_fixed_moh_audio_source

update_fixed_moh_audio_source(**kwargs: Unpack[UpdateFixedMohAudioSource]) -> Dict[str, Any]

Update FixedMohAudioSource configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateFixedMohAudioSource]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ils_config

get_ils_config(**kwargs) -> Dict[str, Any]

Retrieve IlsConfig configuration.

Parameters:

Name	Type	Description	Default
**kwargs		Keyword arguments passed to the WSDL operation. Requires returnedTags.	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ils_config

update_ils_config(**kwargs: Unpack[UpdateIlsConfig]) -> Dict[str, Any]

Update IlsConfig configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateIlsConfig]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ime_feature_config

get_ime_feature_config() -> Dict[str, Any]

Retrieve ImeFeatureConfig configuration.

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ime_feature_config

update_ime_feature_config(**kwargs: Unpack[UpdateImeFeatureConfig]) -> Dict[str, Any]

Update ImeFeatureConfig configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateImeFeatureConfig]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_inter_cluster_directory_uri

update_inter_cluster_directory_uri(**kwargs: Unpack[UpdateInterClusterDirectoryUri]) -> Dict[str, Any]

Update InterClusterDirectoryUri configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateInterClusterDirectoryUri]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_inter_cluster_service_profile

get_inter_cluster_service_profile(**kwargs) -> Dict[str, Any]

Retrieve InterClusterServiceProfile configuration.

Parameters:

Name	Type	Description	Default
**kwargs		Must include interClusterService or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_inter_cluster_service_profile

update_inter_cluster_service_profile(**kwargs: Unpack[UpdateInterClusterServiceProfile]) -> Dict[str, Any]

Update InterClusterServiceProfile configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateInterClusterServiceProfile]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_page_layout_preferences

get_page_layout_preferences(**kwargs) -> Dict[str, Any]

Retrieve PageLayoutPreferences configuration.

Parameters:

Name	Type	Description	Default
**kwargs		Keyword arguments passed to the WSDL operation. Requires pageName.	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_page_layout_preferences

update_page_layout_preferences(**kwargs: Unpack[UpdatePageLayoutPreferences]) -> Dict[str, Any]

Update PageLayoutPreferences configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdatePageLayoutPreferences]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_region_matrix

update_region_matrix(**kwargs: Unpack[UpdateRegionMatrix]) -> Dict[str, Any]

Update RegionMatrix configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateRegionMatrix]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_route_partitions_for_learned_patterns

update_route_partitions_for_learned_patterns(**kwargs: Unpack[UpdateRoutePartitionsForLearnedPatterns]) -> Dict[str, Any]

Update RoutePartitionsForLearnedPatterns configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateRoutePartitionsForLearnedPatterns]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_snmpmib2_list

get_snmpmib2_list(**kwargs) -> Dict[str, Any]

Retrieve SNMPMIB2List configuration.

Parameters:

Name	Type	Description	Default
**kwargs		Keyword arguments passed to the WSDL operation. Requires sysContact.	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_snmpmib2_list

update_snmpmib2_list(**kwargs: Unpack[UpdateSNMPMIB2List]) -> Dict[str, Any]

Update SNMPMIB2List configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateSNMPMIB2List]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_secure_config

get_secure_config(**kwargs) -> Dict[str, Any]

Retrieve SecureConfig configuration.

Parameters:

Name	Type	Description	Default
**kwargs		Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_secure_config

update_secure_config(**kwargs: Unpack[UpdateSecureConfig]) -> Dict[str, Any]

Update SecureConfig configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateSecureConfig]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_soft_key_set

get_soft_key_set(name: str) -> Dict[str, Any]

Retrieve SoftKeySet by name.

Parameters:

Name	Type	Description	Default
name	str	The SoftKeySet name.	required

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_soft_key_set

update_soft_key_set(**kwargs: Unpack[UpdateSoftKeySet]) -> Dict[str, Any]

Update SoftKeySet configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateSoftKeySet]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_syslog_configuration

get_syslog_configuration(**kwargs) -> Dict[str, Any]

Retrieve SyslogConfiguration configuration.

Parameters:

Name	Type	Description	Default
**kwargs		Keyword arguments passed to the WSDL operation.	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_syslog_configuration

update_syslog_configuration(**kwargs: Unpack[UpdateSyslogConfiguration]) -> Dict[str, Any]

Update SyslogConfiguration configuration.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateSyslogConfiguration]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

execute_sql_query_inactive

execute_sql_query_inactive(sql: str) -> Dict[str, Any]

Execute a SQL query against the inactive database partition.

Parameters:

Name	Type	Description	Default
sql	str	The SQL query string.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

do_ldap_sync

do_ldap_sync(name: Optional[str] = None, sync: bool = True) -> Dict[str, Any]

Trigger an LDAP directory sync.

Parameters:

Name	Type	Description	Default
name	Optional[str]	Optional LDAP directory name. If None, syncs all.	None
sync	bool	Whether to sync (default True).	True

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ldap_sync_status

get_ldap_sync_status(name: Optional[str] = None) -> Dict[str, Any]

Get the status of an LDAP sync operation.

Parameters:

Name	Type	Description	Default
name	Optional[str]	Optional LDAP directory name.	None

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

wipe_phone

wipe_phone(name: str) -> Dict[str, Any]

Wipe a phone device.

Parameters:

Name	Type	Description	Default
name	str	The phone device name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_service_parameter

get_service_parameter(process_node_name: str, service: str, name: str) -> Dict[str, Any]

Retrieve a service parameter.

Parameters:

Name	Type	Description	Default
process_node_name	str	The UCM node hostname.	required
service	str	The service name.	required
name	str	The parameter name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_service_parameter

list_service_parameter(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List service parameters.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Search filter dict.	None
returned_tags	Optional[Dict[str, str]]	Fields to return.	None
**kwargs		Additional arguments.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_service_parameter

update_service_parameter(process_node_name: str, service: str, name: str, value: str) -> Dict[str, Any]

Update a service parameter.

Parameters:

Name	Type	Description	Default
process_node_name	str	The UCM node hostname.	required
service	str	The service name.	required
name	str	The parameter name.	required
value	str	The new value.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

do_service_parameters_reset

do_service_parameters_reset() -> Dict[str, Any]

Reset all service parameters to defaults.

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_num_devices

get_num_devices(**kwargs) -> Dict[str, Any]

Get the number of registered devices.

Parameters:

Name	Type	Description	Default
**kwargs		Keyword arguments passed to the WSDL operation. Requires class (device class, e.g. 'Phone').	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_os_version

get_os_version() -> Dict[str, Any]

Get the UCM OS version.

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_phone_options

get_phone_options(uuid: str) -> Dict[str, Any]

Get available phone product options.

Parameters:

Name	Type	Description	Default
uuid	str	The UUID of the phone.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_line_options

get_line_options(uuid: str) -> Dict[str, Any]

Get available line options.

Parameters:

Name	Type	Description	Default
uuid	str	The UUID of the line.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_sip_profile_options

get_sip_profile_options(uuid: str) -> Dict[str, Any]

Get available SIP profile options.

Parameters:

Name	Type	Description	Default
uuid	str	The UUID of the SIP profile.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_trans_pattern_options

get_trans_pattern_options(uuid: str) -> Dict[str, Any]

Get available translation pattern options.

Parameters:

Name	Type	Description	Default
uuid	str	The UUID of the translation pattern.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_phone_type_display_instance

get_phone_type_display_instance(**kwargs) -> Dict[str, Any]

Get phone type display instance info.

Parameters:

Name	Type	Description	Default
**kwargs		Keyword arguments passed to the WSDL operation. Requires productName and protocol.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_transport_settings

get_transport_settings() -> Dict[str, Any]

Get transport settings.

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

do_update_transport_settings

do_update_transport_settings(**kwargs) -> Dict[str, Any]

Update transport settings.

Parameters:

Name	Type	Description	Default
**kwargs		Transport settings to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_licensed_user

get_licensed_user(**kwargs) -> Dict[str, Any]

Retrieve licensed user info.

Parameters:

Name	Type	Description	Default
**kwargs		Must include name or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_licensed_user

list_licensed_user(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List licensed users.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Search filter dict.	None
returned_tags	Optional[Dict[str, str]]	Fields to return.	None
**kwargs		Additional arguments.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_mobile_smart_client_profile

get_mobile_smart_client_profile(name: str) -> Dict[str, Any]

Retrieve a Mobile Smart Client Profile by name.

Parameters:

Name	Type	Description	Default
name	str	The profile name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_mobile_smart_client_profile

list_mobile_smart_client_profile(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List Mobile Smart Client Profiles.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Search filter dict.	None
returned_tags	Optional[Dict[str, str]]	Fields to return.	None
**kwargs		Additional arguments.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_unassigned_device

list_unassigned_device(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List unassigned devices.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Search filter dict.	None
returned_tags	Optional[Dict[str, str]]	Fields to return.	None
**kwargs		Additional arguments.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_unassigned_presence_servers

list_unassigned_presence_servers(**kwargs) -> Dict[str, Any]

List unassigned presence servers.

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_unassigned_presence_users

list_unassigned_presence_users(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List unassigned presence users.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Search filter dict.	None
returned_tags	Optional[Dict[str, str]]	Fields to return.	None
**kwargs		Additional arguments.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_route_plan

list_route_plan(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List route plan entries.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Search filter dict.	None
returned_tags	Optional[Dict[str, str]]	Fields to return.	None
**kwargs		Additional arguments.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

associate_user_devices

associate_user_devices(userid: str, devices: list) -> Dict[str, Any]

Associate phones to an end user.

This is a convenience method that updates the user record to include the given devices in its associatedDevices list.

Parameters:

Name	Type	Description	Default
userid	str	The end user ID.	required
devices	list	List of device name strings.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

add_user_phone_association

add_user_phone_association(user_phone_association_data: UserPhoneAssociation) -> Dict[str, Any]

Provision a user, phone, line, and DN in a single operation.

This wraps the AXL addUserPhoneAssociation operation which creates or updates a user and associates a phone/line/DN in one call.

Parameters:

Name	Type	Description	Default
user_phone_association_data	UserPhoneAssociation	A dict describing the user, phone, line, and DN association. See :class:UserPhoneAssociation.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

add_phone_activation_code

add_phone_activation_code(phone_activation_code_data: PhoneActivationCode) -> Dict[str, Any]

Add a phone activation code.

Parameters:

Name	Type	Description	Default
phone_activation_code_data	PhoneActivationCode	Activation code data dict.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_phone_activation_code

list_phone_activation_code(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List phone activation codes.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Search filter dict.	None
returned_tags	Optional[Dict[str, str]]	Fields to return.	None
**kwargs		Additional arguments.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

remove_phone_activation_code

remove_phone_activation_code(**kwargs) -> Dict[str, Any]

Remove a phone activation code.

Parameters:

Name	Type	Description	Default
**kwargs		Identification of the activation code.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_ime_learned_routes

get_ime_learned_routes(**kwargs) -> Dict[str, Any]

Get IME learned routes.

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

remove_ime_learned_routes

remove_ime_learned_routes(**kwargs) -> Dict[str, Any]

Remove IME learned routes.

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_ime_learned_routes

update_ime_learned_routes(**kwargs: Unpack[UpdateImeLearnedRoutes]) -> Dict[str, Any]

Update IME learned routes.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateImeLearnedRoutes]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_smart_license_status

get_smart_license_status() -> Dict[str, Any]

Get smart license status.

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

do_smart_license_register

do_smart_license_register(**kwargs) -> Dict[str, Any]

Register smart license.

Parameters:

Name	Type	Description	Default
**kwargs		Registration parameters.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

do_smart_license_de_register

do_smart_license_de_register() -> Dict[str, Any]

Deregister smart license.

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

do_smart_license_re_register

do_smart_license_re_register(**kwargs) -> Dict[str, Any]

Re-register smart license.

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

do_smart_license_renew_authorization

do_smart_license_renew_authorization() -> Dict[str, Any]

Renew smart license authorization.

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

do_smart_license_renew_registration

do_smart_license_renew_registration() -> Dict[str, Any]

Renew smart license registration.

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

do_smart_entitlement_request

do_smart_entitlement_request(**kwargs) -> Dict[str, Any]

Submit a smart entitlement request.

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

do_update_license_usage

do_update_license_usage(**kwargs) -> Dict[str, Any]

Update license usage.

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

do_update_remote_cluster

do_update_remote_cluster(**kwargs) -> Dict[str, Any]

Update a remote cluster.

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

unassign_presence_user

unassign_presence_user(**kwargs) -> Dict[str, Any]

Unassign a presence user.

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_credential_policy_default

update_credential_policy_default(**kwargs: Unpack[UpdateCredentialPolicyDefault]) -> Dict[str, Any]

Update the default credential policy.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateCredentialPolicyDefault]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_self_provisioning

update_self_provisioning(**kwargs: Unpack[UpdateSelfProvisioning]) -> Dict[str, Any]

Update self-provisioning settings.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateSelfProvisioning]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_tvs_certificate

get_tvs_certificate(name: str) -> Dict[str, Any]

Retrieve a TVS certificate.

Parameters:

Name	Type	Description	Default
name	str	The certificate name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_tvs_certificate

list_tvs_certificate(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List TVS certificates.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Search filter dict.	None
returned_tags	Optional[Dict[str, str]]	Fields to return.	None
**kwargs		Additional arguments.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

update_tvs_certificate

update_tvs_certificate(**kwargs: Unpack[UpdateTvsCertificate]) -> Dict[str, Any]

Update a TVS certificate.

Parameters:

Name	Type	Description	Default
**kwargs	Unpack[UpdateTvsCertificate]	Fields to update.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

assign_presence_user

assign_presence_user(**kwargs) -> Dict[str, Any]

Assign a presence user.

Parameters:

Name	Type	Description	Default
**kwargs		Presence user assignment parameters.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

do_authenticate_user

do_authenticate_user(userid: str, pin: str) -> Dict[str, Any]

Authenticate an end user.

Parameters:

Name	Type	Description	Default
userid	str	The user ID.	required
pin	str	The user PIN.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

do_change_dnd_status

do_change_dnd_status(**kwargs) -> Dict[str, Any]

Change the Do Not Disturb status for a line/device.

Parameters:

Name	Type	Description	Default
**kwargs		DND parameters (e.g. lineOrDevice, dndStatus).	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

do_device_login

do_device_login(**kwargs) -> Dict[str, Any]

Log in a device (Extension Mobility).

Parameters:

Name	Type	Description	Default
**kwargs		Login parameters (deviceName, loginDuration, userId, profileName).	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

do_device_logout

do_device_logout(**kwargs) -> Dict[str, Any]

Log out a device (Extension Mobility).

Parameters:

Name	Type	Description	Default
**kwargs		Logout parameters (deviceName).	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

do_enterprise_parameters_reset

do_enterprise_parameters_reset() -> Dict[str, Any]

Reset all enterprise parameters to defaults.

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

get_credential_policy_default

get_credential_policy_default(**kwargs) -> Dict[str, Any]

Retrieve the default credential policy.

Parameters:

Name	Type	Description	Default
**kwargs		Must include credentialUser and credentialType; or uuid.	{}

Returns:

Type	Description
Dict[str, Any]	The full AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_annunciator

list_annunciator(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List Annunciator resources.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Search filter dict.	None
returned_tags	Optional[Dict[str, str]]	Fields to return.	None
**kwargs		Additional arguments.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_cisco_cloud_onboarding

list_cisco_cloud_onboarding(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List Cisco Cloud Onboarding configurations.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Search filter dict.	None
returned_tags	Optional[Dict[str, str]]	Fields to return.	None
**kwargs		Additional arguments.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

list_device_defaults

list_device_defaults(search_criteria: Optional[Dict[str, str]] = None, returned_tags: Optional[Dict[str, str]] = None, **kwargs) -> Dict[str, Any]

List device defaults.

Parameters:

Name	Type	Description	Default
search_criteria	Optional[Dict[str, str]]	Search filter dict.	None
returned_tags	Optional[Dict[str, str]]	Fields to return.	None
**kwargs		Additional arguments.	{}

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

lock_phone

lock_phone(name: str) -> Dict[str, Any]

Lock a phone device.

Parameters:

Name	Type	Description	Default
name	str	The phone device name.	required

Returns:

Type	Description
Dict[str, Any]	The AXL response dict.

Raises:

Type	Description
AXLError	On AXL faults.

SQL Sanitization

axltoolkit.axl._sanitize_sql_value

_sanitize_sql_value(value: str) -> str

Escape single quotes in a SQL value to prevent injection.

Parameters:

Name	Type	Description	Default
value	str	A raw string value to be embedded in a SQL query.	required

Returns:

Type	Description
str	The value with single quotes doubled (' → '').

Raises:

Type	Description
AXLSQLInjectionError	If the value contains suspicious SQL patterns.