Python ncs.maapi Module

MAAPI high level module.

This module defines a high level interface to the low-level maapi functions.

The 'Maapi' class encapsulates a MAAPI connection which upon constructing, sets up a connection towards ConfD/NCS. An example of setting up a transaction and manipulating data:

import ncs

m = ncs.maapi.Maapi()
m.start_user_session('admin', 'test_context')
t = m.start_write_trans()
t.get_elem('/model/data{one}/str')
t.set_elem('testing', '/model/data{one}/str')
t.apply()

Another way is to use context managers, which will handle all cleanup related to transactions, user sessions and socket connections:

with ncs.maapi.Maapi() as m:
    with ncs.maapi.Session(m, 'admin', 'test_context'):
        with m.start_write_trans() as t:
            t.get_elem('/model/data{one}/str')
            t.set_elem('testing', '/model/data{one}/str')
            t.apply()

Finally, a really compact way of doing this:

with ncs.maapi.single_write_trans('admin', 'test_context') as t:
    t.get_elem('/model/data{one}/str')
    t.set_elem('testing', '/model/data{one}/str')
    t.apply()

Functions

connect

connect(ip='127.0.0.1', port=None, path='/tmp/nso/nso-ipc')

Convenience function for connecting to ConfD/NCS.

If 'port' is provided the connection uses TCP (with 'ip' defaulting to the value of NCS_IPC_ADDR / '127.0.0.1'). Otherwise, if 'path' is provided, Local IPC is used.

Arguments:

ip -- ConfD/NCS instance ip address (str)
port -- ConfD/NCS instance port (int)
path -- ConfD/NCS instance socket path (str)

Returns:

socket (Python socket)

retry_on_conflict

retry_on_conflict(retries=10, log=None)

Function/method decorator to retry a transaction in case of conflicts.

When executing multiple concurrent transactions against the NCS RUNNING datastore, read-write conflicts are resolved by rejecting transactions having potentially stale data with ERR_TRANSACTION_CONFLICT.

This decorator restarts a function, should it run into a conflict, giving it multiple attempts to apply. The decorated function must start its own transaction because a conflicting transaction must be thrown away entirely and a new one started.

Example usage:

@retry_on_conflict()
def do_work():
    with ncs.maapi.single_write_trans('admin', 'python') as t:
        root = ncs.maagic.get_root(t)
        root.some_value = str(root.some_other_value)
        t.apply()

Arguments:

retries -- number of times to retry (int)
log -- optional log object for logging conflict details

single_read_trans

single_read_trans(user, context, groups=[], db=2, ip='127.0.0.1', port=None, path='/tmp/nso/nso-ipc', src_ip='127.0.0.1', src_port=0, proto=1, vendor=None, product=None, version=None, client_id=None, load_schemas=True, flags=0)

Context manager for a single READ transaction.

This function connects to ConfD/NCS, starts a user session and finally starts a new READ transaction.

Function signature:

def single_read_trans(user, context, groups=[],
                      db=RUNNING, ip=<CONFD-OR-NCS-ADDR>,
                      port=<CONFD-OR-NCS-PORT>, path=None,
                      src_ip=<CONFD-OR-NCS-ADDR>, src_port=0,
                      proto=PROTO_TCP,
                      vendor=None, product=None, version=None,
                      client_id=_mk_client_id(),
                      load_schemas=LOAD_SCHEMAS_LOAD, flags=0):

For argument db, flags see Maapi.start_trans(). For arguments user, context, groups, src_ip, src_port, proto, vendor, product, version and client_id see Maapi.start_user_session(). For arguments ip, port and path see connect(). For argument load_schemas see init().

Arguments:

user - username (str)
context - context for the session (str)
groups - groups (list)
db -- database (int)
ip -- ConfD/NCS instance ip address (str)
port -- ConfD/NCS instance port (int)
path -- ConfD/NCS instance location path (str)
src_ip - source ip address (str)
src_port - source port (int)
proto - protocol used by for connecting (i.e. ncs.PROTO_TCP)
vendor -- lock error information (str, optional)
product -- lock error information (str, optional)
version -- lock error information (str, optional)
client_id -- lock error information (str, optional)
load_schemas - passed on to Maapi.init()
flags -- additional transaction flags (int)

Returns:

read transaction object (maapi.Transaction)

single_write_trans

single_write_trans(user, context, groups=[], db=2, ip='127.0.0.1', port=None, path='/tmp/nso/nso-ipc', src_ip='127.0.0.1', src_port=0, proto=1, vendor=None, product=None, version=None, client_id=None, load_schemas=True, flags=0)

Context manager for a single READ/WRITE transaction.

This function connects to ConfD/NCS, starts a user session and finally starts a new READ/WRITE transaction.

Function signature:

def single_write_trans(user, context, groups=[],
                       db=RUNNING, ip=<CONFD-OR-NCS-ADDR>,
                       port=<CONFD-OR-NCS-PORT>, path=None,
                       src_ip=<CONFD-OR-NCS-ADDR>, src_port=0,
                       proto=PROTO_TCP,
                       vendor=None, product=None, version=None,
                       client_id=_mk_client_id(),
                       load_schemas=LOAD_SCHEMAS_LOAD, flags=0):

Arguments:

user - username (str)
context - context for the session (str)
groups - groups (list)
db -- database (int)
ip -- ConfD/NCS instance ip address (str)
port -- ConfD/NCS instance port (int)
path -- ConfD/NCS instance location path (str)
src_ip - source ip address (str)
src_port - source port (int)
proto - protocol used by the client for connecting (int)
vendor -- lock error information (str, optional)
product -- lock error information (str, optional)
version -- lock error information (str, optional)
client_id -- lock error information (str, optional)
load_schemas - passed on to Maapi.init()
flags -- additional transaction flags (int)

Returns:

write transaction object (maapi.Transaction)

Classes

class CommitParams

Class representing NSO commit parameters.

Start with creating an empty instance of this class and set commit parameters using helper methods.

CommitParams(result=None)

Members:

comment(...)

Method:

comment(self, comment)

Set comment.

commit_queue_async(...)

Method:

commit_queue_async(self)

Set commit queue asynchronous mode of operation.

commit_queue_atomic(...)

Method:

commit_queue_atomic(self)

Make the commit queue item atomic.

commit_queue_block_others(...)

Method:

commit_queue_block_others(self)

Make the commit queue item block other commit queue items for this device.

commit_queue_bypass(...)

Method:

commit_queue_bypass(self)

Make the commit transactional even if commit queue is configured by default.

commit_queue_error_option(...)

Method:

commit_queue_error_option(self, error_option)

Set commit queue item behaviour on error.

commit_queue_lock(...)

Method:

commit_queue_lock(self)

Make the commit queue item locked.

commit_queue_non_atomic(...)

Method:

commit_queue_non_atomic(self)

Make the commit queue item non-atomic.

commit_queue_sync(...)

Method:

commit_queue_sync(self, timeout=None)

Set commit queue synchronous mode of operation.

confirm_network_state(...)

Method:

confirm_network_state(self)

Check that the parts of the device configuration read and/or modified are up-to-date in CDB before pushing the configuration change to the device.

confirm_network_state_mode(...)

Method:

confirm_network_state_mode(self, mode)

Set the mode for confirm-network-state.

confirm_network_state_re_deploy_all(...)

Method:

confirm_network_state_re_deploy_all(self)

Re-deploy all services affected by discovered out-of-band data

confirm_network_state_re_evaluate_policies(...)

Method:

confirm_network_state_re_evaluate_policies(self)

Check that the parts of the device configuration read and/or modified are up-to-date in CDB before pushing the configuration change to the device and re-evaluate policies of effected services.

This function is deprecated and will be removed in a future release. Use confirm_network_state_mode() instead.

confirm_network_state_scope(...)

Method:

confirm_network_state_scope(self, scope)

Set the scope for confirm-network-state.

dry_run_cli(...)

Method:

dry_run_cli(self)

Dry-run commit outformat CLI.

dry_run_cli_c(...)

Method:

dry_run_cli_c(self)

Dry-run commit outformat cli-c.

dry_run_cli_c_reverse(...)

Method:

dry_run_cli_c_reverse(self)

Dry-run commit outformat cli-c reverse.

dry_run_native(...)

Method:

dry_run_native(self)

Dry-run commit outformat native.

dry_run_native_reverse(...)

Method:

dry_run_native_reverse(self)

Dry-run commit outformat native reverse.

dry_run_xml(...)

Method:

dry_run_xml(self)

Dry-run commit outformat XML.

get_comment(...)

Method:

get_comment(self)

Get comment.

get_commit_queue_error_option(...)

Method:

get_commit_queue_error_option(self)

Get commit queue item behaviour on error.

get_commit_queue_sync_timeout(...)

Method:

get_commit_queue_sync_timeout(self)

Get commit queue synchronous mode of operation timeout.

get_confirm_network_state_mode(...)

Method:

get_confirm_network_state_mode(self)

Get the mode for confirm-network-state.

get_confirm_network_state_scope(...)

Method:

get_confirm_network_state_scope(self)

Get the scope for confirm-network-state.

get_dry_run_outformat(...)

Method:

get_dry_run_outformat(self)

Get dry-run outformat

get_label(...)

Method:

get_label(self)

Get label.

get_no_overwrite_scope(...)

Method:

get_no_overwrite_scope(self)

Get no-overwrite scope

get_tagvalues(...)

Method:

get_tagvalues(self)

Get commit parameters as a list of TagValue's.

get_trace_id(...)

Method:

get_trace_id(self)

Get trace id.

is_commit_queue_async(...)

Method:

is_commit_queue_async(self)

Get commit queue asynchronous mode of operation.

is_commit_queue_atomic(...)

Method:

is_commit_queue_atomic(self)

Check if the commit queue item should be atomic.

is_commit_queue_block_others(...)

Method:

is_commit_queue_block_others(self)

Check if the the commit queue item should block other commit queue items for this device.

is_commit_queue_bypass(...)

Method:

is_commit_queue_bypass(self)

Check if the commit is transactional even if commit queue is configured by default.

is_commit_queue_lock(...)

Method:

is_commit_queue_lock(self)

Check if the commit queue item should be locked.

is_commit_queue_non_atomic(...)

Method:

is_commit_queue_non_atomic(self)

Check if the commit queue item should be non-atomic.

is_commit_queue_sync(...)

Method:

is_commit_queue_sync(self)

Get commit queue synchronous mode of operation.

is_confirm_network_state(...)

Method:

is_confirm_network_state(self)

Should a check be done that the parts of the device configuration read and/or modified are up-to-date in CDB before pushing the configuration change to the device.

is_confirm_network_state_re_deploy_all(...)

Method:

is_confirm_network_state_re_deploy_all(self)

Is confirm-network-state with re-deploy-all enabled.

is_confirm_network_state_re_evaluate_policies(...)

Method:

is_confirm_network_state_re_evaluate_policies(self)

Is confirm-network-state with re-evaluate-policies enabled.

This function is deprecated and will be removed in a future release. Use get_confirm_network_state_mode() instead.

is_dry_run(...)

Method:

is_dry_run(self)

Is dry-run enabled

is_dry_run_reverse(...)

Method:

is_dry_run_reverse(self)

Is dry-run reverse enabled.

is_no_deploy(...)

Method:

is_no_deploy(self)

Should service create method be invoked or not.

is_no_lsa(...)

Method:

is_no_lsa(self)

Get no-lsa commit parameter.

is_no_networking(...)

Method:

is_no_networking(self)

Check if the the configuration should only be written to CDB and not actually pushed to the device.

is_no_out_of_sync_check(...)

Method:

is_no_out_of_sync_check(self)

Do not check device sync state before pushing the configuration change.

is_no_overwrite(...)

Method:

is_no_overwrite(self)

Should a check be done that the parts of the device configuration to be modified are up-to-date in CDB before pushing the configuration change to the device.

is_no_revision_drop(...)

Method:

is_no_revision_drop(self)

Get no-revision-drop commit parameter.

is_reconcile_attach_non_service_config(...)

Method:

is_reconcile_attach_non_service_config(self)

Get reconcile commit parameter with attach-non-service-config behaviour.

is_reconcile_detach_non_service_config(...)

Method:

is_reconcile_detach_non_service_config(self)

Get reconcile commit parameter with detach-non-service-config behaviour.

is_reconcile_discard_non_service_config(...)

Method:

is_reconcile_discard_non_service_config(self)

Get reconcile commit parameter with discard-non-service-config behaviour.

is_reconcile_keep_non_service_config(...)

Method:

is_reconcile_keep_non_service_config(self)

Get reconcile commit parameter with keep-non-service-config behaviour.

is_use_lsa(...)

Method:

is_use_lsa(self)

Get use-lsa commit parameter.

is_with_service_meta_data(...)

Method:

is_with_service_meta_data(self)

Get with-service-meta-data commit parameter.

label(...)

Method:

label(self, label)

Set label.

no_deploy(...)

Method:

no_deploy(self)

Do not invoke service's create method.

no_lsa(...)

Method:

no_lsa(self)

Set no-lsa commit parameter.

no_networking(...)

Method:

no_networking(self)

Only write the configuration to CDB, do not actually push it to the device.

no_out_of_sync_check(...)

Method:

no_out_of_sync_check(self)

Do not check device sync state before pushing the configuration change.

no_overwrite(...)

Method:

no_overwrite(self, scope)

Check that the parts of the device configuration to be modified are up-to-date in CDB before pushing the configuration change to the device.

no_revision_drop(...)

Method:

no_revision_drop(self)

Set no-revision-drop commit parameter.

reconcile_attach_non_service_config(...)

Method:

reconcile_attach_non_service_config(self)

Set reconcile commit parameter with attach-non-service-config behaviour.

reconcile_detach_non_service_config(...)

Method:

reconcile_detach_non_service_config(self)

Set reconcile commit parameter with detach-non-service-config behaviour.

reconcile_discard_non_service_config(...)

Method:

reconcile_discard_non_service_config(self)

Set reconcile commit parameter with discard-non-service-config behaviour.

reconcile_keep_non_service_config(...)

Method:

reconcile_keep_non_service_config(self)

Set reconcile commit parameter with keep-non-service-config behaviour.

set_dry_run_outformat(...)

Method:

set_dry_run_outformat(self, outformat)

Set dry-run outformat

set_reconcile_exclude_paths(...)

Method:

set_reconcile_exclude_paths(self, xpaths)

Set paths to be excluded during reconciliation.

set_reconcile_include_paths(...)

Method:

set_reconcile_include_paths(self, xpaths)

Set paths to be included during reconciliation.

trace_id(...)

Method:

trace_id(self, trace_id)

Set trace id.

use_lsa(...)

Method:

use_lsa(self)

Set use-lsa commit parameter.

with_service_meta_data(...)

Method:

with_service_meta_data(self)

Set with-service-meta-data commit parameter.

class ConfirmNetworkStateMode

Enumeration for confirm network state modes: NORMAL = 1 RE_EVALUATE_POLICIES = 2

ConfirmNetworkStateMode(*values)

Members:

NORMAL

NORMAL = 1

RE_EVALUATE_POLICIES

RE_EVALUATE_POLICIES = 2

name

The name of the Enum member.

value

The value of the Enum member.

class ConfirmNetworkStateScope

Enumeration for confirm network state scopes: WRITE_AND_FULL_READ_SET = 1 WRITE_AND_SERVICE_READ_SET = 2

ConfirmNetworkStateScope(*values)

Members:

WRITE_AND_FULL_READ_SET

WRITE_AND_FULL_READ_SET = 1

WRITE_AND_SERVICE_READ_SET

WRITE_AND_SERVICE_READ_SET = 2

name

The name of the Enum member.

value

The value of the Enum member.

class DryRunOutformat

Enumeration for dry run formats: XML = 1 CLI = 2 NATIVE = 3 CLI_C = 4

DryRunOutformat(*values)

Members:

CLI

CLI = 2

CLI_C

CLI_C = 4

NATIVE

NATIVE = 3

XML

XML = 1

name

The name of the Enum member.

value

The value of the Enum member.

class Key

Key string encapsulation and helper.

Key(key, enum_cs_nodes=None)

Initialize a key.

'key' may be a string or a list of strings.

Members:

None

class Maapi

Class encapsulating a MAAPI connection.

Maapi(ip='127.0.0.1', port=None, path='/tmp/nso/nso-ipc', load_schemas=True, msock=None)

Create a Maapi instance.

Arguments:

ip -- ConfD/NCS instance ip address (str, optional)
port -- ConfD/NCS instance port (int, optional)
path -- ConfD/NCS instance location path (str, optional)
msock -- already connected MAAPI socket (socket.socket, optional) (ip, port and path ignored)
load_schemas -- whether schemas should be loaded/reloaded or not LOAD_SCHEMAS_LOAD = load schemas unless already loaded LOAD_SCHEMAS_SKIP = do not load schemas LOAD_SCHEMAS_RELOAD = force reload of schemas

The option LOAD_SCHEMAS_RELOAD can be used to force a reload of schemas, for example when connecting to a different ConfD/NSO node. Note that previously constructed maagic objects will be invalid and using them will lead to undefined behavior. Use this option with care, for example in a small script querying a list of running nodes.

Members:

apply_template(...)

Method:

apply_template(self, th, name, path, vars=None, flags=0)

Apply a template.

attach(...)

Method:

attach(self, ctx_or_th, hashed_ns=0, usid=0)

Attach to an existing transaction.

'ctx_or_th' may be either a TransCtxRef or a transaction handle. The 'hashed_ns' argument is basically just there to save a call to set_namespace(). 'usid' is only used if 'ctx_or_th' is a transaction handle and if set to 0 the user session id that is the owner of the transaction will be used.

Arguments:

ctx_or_th (TransCtxRef or transaction handle)
hashed_ns (int)
usid (int)

Returns:

transaction object (maapi.Transaction)

attach_init(...)

Method:

attach_init(self)

Attach to phase0 for CDB initialization and upgrade.

authenticate(...)

Method:

authenticate(self, user, password, n, src_addr=None, src_port=None, context=None, prot=None)

Authenticate a user using the AAA configuration.

Use src_addr, src_port, context and prot to use an external authentication executable. Use the 'n' to get a list of n-1 groups that the user is a member of. Use n=1 if the function is used in a context where the group names are not needed.

Returns 1 if accepted without groups. If the authentication failed or was accepted a tuple with first element status code, 0 for rejection and 1 for accepted is returned. The second element either contains the reason for the rejection as a string OR a list groupnames.

Arguments:

user - username (str)
password - passwor d (str)
n - number of groups to return (int)
src_addr - source ip address (str)
src_port - source port (int)
context - context for the session (str)
prot - protocol used by the client for connecting (int)

Returns:

status (int or tuple)

clear_read_intent(...)

Method:

clear_read_intent(self, th)

Clear the read intent for the transaction.

This function clears the read intent for the given XPath in the transaction, which can be used for optimization purposes by the ConfD/NCS system.

Arguments:

th -- transaction handle

close(...)

Method:

close(self)

Ends session and closes socket.

cursor(...)

Method:

cursor(self, th, path, enum_cs_nodes=None, want_values=False, secondary_index=None, xpath_expr=None)

Get an iterable list cursor.

destroy_cursor(...)

Method:

destroy_cursor(self, mc)

Destroy cursor.

Arguments:

cursor (maapi.Cursor)

detach(...)

Method:

detach(self, ctx_or_th)

Detach the underlying MAAPI socket.

Arguments:

ctx_or_th (TransCtxRef or transaction handle)

do_display(...)

Method:

do_display(self, th, path)

Do display.

If the data model uses the YANG when or tailf:display-when statement, this function can be used to determine if the item given by the path should be displayed or not.

Arguments:

th -- transaction handle
path -- path to the 'display-when' statement (str)

Returns

boolean

end_progress_span(...)

Method:

end_progress_span(self, *args)

Don't call this function.

Call instance.end() on the progress.Span instance created from start_progress_span() instead.

exists(...)

Method:

exists(self, th, path)

Check if path exists.

Arguments:

th -- transaction handle
path -- path to the node in the data tree (str)

Returns:

boolean

find_next(...)

Method:

find_next(self, mc, type, inkeys)

Find next.

Update the cursor 'mc' with the key(s) for the list entry designated by the 'type' and 'inkeys' arguments. This function may be used to start a traversal from an arbitrary entry in a list. Keys for subsequent entries may be retrieved with the get_next() function. When no more keys are found, False is returned.

The strategy to use is defined by 'type':

FIND_NEXT - The keys for the first list entry after the one
            indicated by the 'inkeys' argument.
FIND_SAME_OR_NEXT - If the values in the 'inkeys' array completely
            identifies an actual existing list entry, the keys for
            this entry are requested. Otherwise the same logic as
            for FIND_NEXT above.

get_next(...)

Method:

get_next(self, mc)

Iterate and get the keys for the next entry in a list.

When no more keys are found, False is returned

Arguments:

cursor (maapi.Cursor)

Returns:

keys (list or boolean)

get_objects(...)

Method:

get_objects(self, mc, n, nobj)

Get objects.

Read at most n values from each nobj lists starting at cursor mc. Returns a list of Value's.

Arguments:

mc (maapi.Cursor)
n -- at most n values will be read (int)
nobj -- number of nobj lists which n elements will be taken from (int)

Returns:

list of values (list)

get_read_intent(...)

Method:

get_read_intent(self, th)

Get the read intent for the transaction.

This function gets the read intents for the transaction, which can be used for optimization purposes by the ConfD/NCS system.

Arguments:

th -- transaction handle

Returns:

list of path read intent (list)

get_running_db_status(...)

Method:

get_running_db_status(self)

Get running db status.

Gets the status of the running db. Returns True if consistent and False otherwise.

Returns:

boolean

get_template_variables(...)

Method:

get_template_variables(self, name, type_enum)

Get template variables for specific types.

get_trans_mode(...)

Method:

get_trans_mode(self, th)

Get transaction mode for a transaction handle.

Arguments:

th -- a transaction handle.

Returns:

Either READ or READ_WRITE flag (ncs) or -1 (no transaction).

Readonly property

Return address to connect to the IPC port

load_schemas(...)

Method:

load_schemas(self, use_maapi_socket=False)

Load the schemas to Python (using shared memory if enabled).

If 'use_maapi_socket' is set to True, the schmeas are loaded through the NSO daemon via a MAAPI socket.

netconf_ssh_call_home(...)

Method:

netconf_ssh_call_home(self, host, port=4334)

Initiate NETCONF SSH Call Home.

netconf_ssh_call_home_opaque(...)

Method:

netconf_ssh_call_home_opaque(self, host, opaque, port=4334)

Initiate NETCONF SSH Call Home w. opaque data.

path

Readonly property

Return path to connect to the IPC port

port

Readonly property

Return port to connect to the IPC port

progress_info(...)

Method:

progress_info(self, msg, verbosity=0, attrs=None, links=None, path=None)

While spans represents a pair of data points: start and stop; info events are instead singular events, one point in time. Call progress_info() to write a progress span info event to the progress trace. The info event will have the same span-id as the start and stop events of the currently ongoing progress span in the active user session or transaction. See help for start_progress_span() for more information.

Arguments:

msg - message to report (str)
verbosity - ncs.VERBOSITY_*, VERBOSITY_NORMAL is default (optional)
attrs - user defined attributes (optional)
links - list of ncs.progress.Span or dict (optional)
path - keypath to an action/leaf/service/etc (str, optional)

query_free_result(...)

Method:

query_free_result(self, qrs)

Deallocate QueryResult memory.

Deallocated memory inside the QueryResult object 'qrs' returned from query_result(). It is not necessary to call this method as deallocation will be done when the Python library garbage collects the QueryResult object.

Arguments:

qrs -- the query result structure to free

report_progress(...)

Method:

report_progress(self, th, verbosity, msg, package=None)

Report transaction/action progress.

The 'package' argument is only available to NCS.

This function is deprecated and will be removed in a future release. Use progress_info() instead.

report_progress_start(...)

Method:

report_progress_start(self, th, verbosity, msg, package=None)

Report transaction/action progress.

Used for calculation of the duration between two events. The method returns a _Progress object to be passed to report_progress_stop() once the event has finished.

The 'package' argument is only available to NCS.

This function is deprecated and will be removed in a future release. Use start_progress_span() instead.

report_progress_stop(...)

Method:

report_progress_stop(self, th, progress, annotation=None)

Report transaction/action progress.

Used for calculation of the duration between two events. The method takes a _Progress object returned from report_progress_start().

This function is deprecated and will be removed in a future release. Use end_progress_span() instead.

report_service_progress(...)

Method:

report_service_progress(self, th, verbosity, msg, path, package=None)

Report transaction progress for a FASTMAP service.

This function is deprecated and will be removed in a future release. Use progress_info() instead.

report_service_progress_start(...)

Method:

report_service_progress_start(self, th, verbosity, msg, path, package=None)

Report transaction progress for a FASTMAP service.

Used for calculation of the duration between two events. The method returns a _Progress object to be passed to report_service_progress_stop() once the event has finished.

This function is deprecated and will be removed in a future release. Use start_progress_span() instead.

report_service_progress_stop(...)

Method:

report_service_progress_stop(self, th, progress, annotation=None)

Report transaction progress for a FASTMAP service.

Used for calculation of the duration between two events. The method takes a _Progress object returned from report_service_progress_start().

This function is deprecated and will be removed in a future release. Use end_progress_span() instead.

run_with_retry(...)

Method:

run_with_retry(self, fun, max_num_retries=10, commit_params=None, usid=0, flags=0, vendor=None, product=None, version=None, client_id=None)

Run fun with a new read-write transaction against RUNNING.

The transaction is applied if fun returns True. The fun is only retried in case of transaction conflicts. Each retry is run using a new transaction.

The last conflict error.Error is thrown in case of max number of retries is reached.

Arguments:

fun - work fun (fun(maapi.Transaction) -> bool)
usid - user id (int)
max_num_retries - maximum number of retries (int)

Returns:

bool True if transation was applied, else False.

safe_create(...)

Method:

safe_create(self, th, path)

Safe version of create.

Create a new list entry, a presence container, or a leaf of type empty in the data tree - if it doesn't already exist.

Arguments:

th -- transaction handle
path -- path to the new element (str)

safe_delete(...)

Method:

safe_delete(self, th, path)

Safe version of delete.

Delete an existing list entry, a presence container, or an optional leaf and all its children (if any) from the data tree. If it exists.

Arguments:

th -- transaction handle
path -- path to the element (str)

safe_get_elem(...)

Method:

safe_get_elem(self, th, path)

Safe version of get_elem.

Read the element at 'path', returns 'None' if it doesn't exist.

Arguments:

th -- transaction handle
path -- path to the element (str)

Returns:

configuration element

safe_get_object(...)

Method:

safe_get_object(self, th, n, path)

Safe version of get_object.

This function reads at most 'n' values from the list entry or container specified by the 'path'. Returns 'None' the path is empty.

Arguments:

th -- transaction handle
n -- at most n values (int)
path -- path to the object (str)

Returns:

configuration object

set_elem(...)

Method:

set_elem(self, th, value, path)

Set the node at 'path' to 'value'.

If 'value' is not of type Value it will be converted to a string before calling set_elem2() under the hood.

Arguments:

th -- transaction handle
value -- element value (Value or str)
path -- path to the element (str)

set_read_intent(...)

Method:

set_read_intent(self, th, xpath_or_xpaths)

Set a read intent for the transaction.

This function sets a read intent for the given XPath in the transaction, which can be used for optimization purposes by the ConfD/NCS system.

Arguments:

th -- transaction handle
xpath_or_xpaths -- A single XPath or a list of xpaths (str or list)

shared_apply_template(...)

Method:

shared_apply_template(self, th, name, path, vars=None, flags=0)

FASTMAP version of apply_template().

shared_copy_tree(...)

Method:

shared_copy_tree(self, th, from_path, to_path, flags=0)

FASTMAP version of copy_tree().

shared_create(...)

Method:

shared_create(self, th, path, flags=0)

FASTMAP version of create().

shared_insert(...)

Method:

shared_insert(self, th, path, flags=0)

FASTMAP version of insert().

shared_set_elem(...)

Method:

shared_set_elem(self, th, value, path, flags=0)

FASTMAP version of set_elem().

If 'value' is not of type Value it will be converted to a string before calling shared_set_elem2() under the hood.

shared_set_values(...)

Method:

shared_set_values(self, th, values, path, flags=0)

FASTMAP version of set_values().

start_progress_span(...)

Method:

start_progress_span(self, msg, verbosity=0, attrs=None, links=None, path=None)

Starts a progress span. Progress spans are trace messages written to the progress trace and the developer log. A progress span consists of a start and a stop event which can be used to calculate the duration between the two. Those events can be identified with unique span-ids. Inside the span it is possible to start new spans, which will then become child spans, the parent-span-id is set to the previous spans' span-id. A child span can be used to calculate the duration of a sub task, and is started from consecutive maapi_start_progress_span() calls, and is ended with maapi_end_progress_span().

The concepts of traces, trace-id and spans are highly influenced by https://opentelemetry.io/docs/concepts/signals/traces/#spans

Call help(ncs.progress) or help(confd.progress) for examples.

Arguments:

msg - message to report (str)
verbosity - ncs.VERBOSITY_*, VERBOSITY_NORMAL is default (optional)
attrs - user defined attributes (optional)
links - list of ncs.progress.Span or dict (optional)
path - keypath to an action/leaf/service/etc (str, optional)

Returns:

trace span (ncs.progress.Span)

start_read_trans(...)

Method:

start_read_trans(self, db=2, usid=0, flags=0, vendor=None, product=None, version=None, client_id=None)

Start a read transaction.

For details see start_trans().

start_trans(...)

Method:

start_trans(self, rw, db=2, usid=0, flags=0, vendor=None, product=None, version=None, client_id=None)

Start a transaction towards the 'db'.

This function starts a new a new transaction towards the given data store.

Arguments:

rw -- Either READ or READ_WRITE flag (ncs)
db -- Either CANDIDATE, RUNNING or STARTUP flag (cdb)
usid -- user id (int)
flags -- additional transaction flags (int)
vendor -- lock error information (str, optional)
product -- lock error information (str, optional)
version -- lock error information (str, optional)
client_id -- lock error information (str, optional)

Returns:

transaction (maapi.Transaction)

Flags (maapi):

FLAG_HINT_BULK
FLAG_NO_DEFAULTS
FLAG_CONFIG_ONLY
FLAG_HIDE_INACTIVE
FLAG_DELAYED_WHEN
FLAG_NO_CONFIG_CACHE
FLAG_CONFIG_CACHE_ONLY
FLAG_HIDE_ALL_HIDEGROUPS
FLAG_SKIP_SUBSCRIBERS

start_trans_in_trans(...)

Method:

start_trans_in_trans(self, th, readwrite, usid=0)

Start a new transaction within a transaction.

This function makes it possible to start a transaction with another transaction as backend, instead of an actual data store. This can be useful if we want to make a set of related changes, and then either apply or discard them all based on some criterion, while other changes remain unaffected. The thandle identifies the backend transaction to use. If 'usid' is 0, the transaction will be started within the user session associated with the MAAPI socket, otherwise it will be started within the user session given by usid. If we call apply() on this "transaction in a transaction" object, the changes (if any) will be applied to the backend transaction. To discard the changes, call finish() without calling apply() first.

Arguments:

th -- transaction handle
readwrite -- Either READ or READ_WRITE flag (ncs)
usid -- user id (int)

Returns:

transaction (maapi.Transaction)

start_user_session(...)

Method:

start_user_session(self, user, context, groups=[], src_ip='127.0.0.1', src_port=0, proto=1, vendor=None, product=None, version=None, client_id=None, path='/tmp/nso/nso-ipc')

Start a new user session.

This method gives some resonable defaults.

Arguments:

user - username (str)
context - context for the session (str)
groups - groups (list)
src_ip - source ip address (str)
src_port - source port (int)
proto - protocol used by for connecting (i.e. ncs.PROTO_TCP)
vendor -- lock error information (str, optional)
product -- lock error information (str, optional)
version -- lock error information (str, optional)
client_id -- lock error information (str, optional)
path -- path to Unix-domain socket (only for NSO)

Protocol flags (ncs):

PROTO_CONSOLE
PROTO_HTTP
PROTO_HTTPS
PROTO_SSH
PROTO_SSL
PROTO_SYSTEM
PROTO_TCP
PROTO_TLS
PROTO_TRACE
PROTO_UDP

Example use:

maapi.start_user_session(
      sock_maapi,
      'admin',
      'python',
      [],
      _ncs.ADDR,
      _ncs.PROTO_TCP)

start_write_trans(...)

Method:

start_write_trans(self, db=2, usid=0, flags=0, vendor=None, product=None, version=None, client_id=None)

Start a write transaction.

For details see start_trans().

write_service_log_entry(...)

Method:

write_service_log_entry(self, path, msg, type, level)

Write service log entries.

This function makes it possible to write service log entries from FASTMAP code.

class NoOverwriteScope

Enumeration for no-overwrite scopes: WRITE_SET_ONLY = 1 WRITE_AND_FULL_READ_SET = 2 WRITE_AND_SERVICE_READ_SET = 3

NoOverwriteScope(*values)

Members:

WRITE_AND_FULL_READ_SET

WRITE_AND_FULL_READ_SET = 2

WRITE_AND_SERVICE_READ_SET

WRITE_AND_SERVICE_READ_SET = 3

WRITE_SET_ONLY

WRITE_SET_ONLY = 1

name

The name of the Enum member.

value

The value of the Enum member.

class Session

Encapsulate a MAAPI user session.

Context manager for user sessions. This class makes it easy to use a single Maapi connection and switch user session along the way. For example:

with Maapi() as m:
    for user, context, device in devlist:
        with Session(m, user, context):
            with m.start_write_trans() as t:
                # ...
                # do something using the correct user session
                # ...
                t.apply()

Session(maapi, user, context, groups=[], src_ip='127.0.0.1', src_port=0, proto=1, vendor=None, product=None, version=None, client_id=None, path='/tmp/nso/nso-ipc')

Initialize a Session object via start_user_session().

Arguments:

maapi -- maapi object (maapi.Maapi)
for all other arguments see start_user_session()

Members:

close(...)

Method:

close(self)

Close the user session.

class TemplateTypes

Enumeration for template types: DEVICE_TEMPLATE = 0 SERVICE_TEMPLATE = 1 COMPLIANCE_TEMPLATE = 2

TemplateTypes(*values)

Members:

COMPLIANCE_TEMPLATE

COMPLIANCE_TEMPLATE = 2

DEVICE_TEMPLATE

DEVICE_TEMPLATE = 0

SERVICE_TEMPLATE

SERVICE_TEMPLATE = 1

name

The name of the Enum member.

value

The value of the Enum member.

class Transaction

Class that corresponds to a single MAAPI transaction.

Transaction(maapi, th=None, rw=None, db=2, vendor=None, product=None, version=None, client_id=None)

Initialize a Transaction object.

When created one may access the maapi and th arguments like this:

trans = Transaction(mymaapi, th=myth)
trans.maapi # the Maapi object
trans.th # the transaction handle

An instance of this class is also a context manager:

with Transaction(mymaapi, th=myth) as trans:
    # do something here...

When exiting the with statement, finish() will be called.

If 'th' is left out (or None) a new transaction is started using the 'db' and 'rw' arguments, otherwise 'db' and 'rw' are ignored.

Arguments:

maapi -- a Maapi object (maapi.Maapi)
th -- a transaction handle or None
rw -- Either READ or READ_WRITE flag (ncs)
db -- Either CANDIDATE, RUNNING or STARTUP flag (cdb)
vendor -- lock error information (optional)
product -- lock error information (optional)
version -- lock error information (optional)
client_id -- lock error information (optional)

Members:

abort(...)

Method:

abort(self)

Abort the transaction.

apply(...)

Method:

apply(self, keep_open=True, flags=0)

Apply the transaction.

Validates, prepares and eventually commits or aborts the transaction. If the validation fails and the 'keep_open' argument is set to True (default), the transaction is left open and the developer can react upon the validation errors.

Arguments:

keep_open -- keep transaction open (boolean)
flags - additional transaction flags (int)

Flags (maapi):

COMMIT_NCS_NO_REVISION_DROP
COMMIT_NCS_NO_DEPLOY
COMMIT_NCS_NO_NETWORKING
COMMIT_NCS_NO_OUT_OF_SYNC_CHECK
COMMIT_NCS_NO_OVERWRITE_WRITE_SET_ONLY
COMMIT_NCS_NO_OVERWRITE_WRITE_AND_FULL_READ_SET
COMMIT_NCS_NO_OVERWRITE_WRITE_AND_FULL_SERVICE_SET
COMMIT_NCS_USE_LSA
COMMIT_NCS_NO_LSA
COMMIT_NCS_RECONCILE_KEEP_NON_SERVICE_CONFIG
COMMIT_NCS_RECONCILE_DISCARD_NON_SERVICE_CONFIG
COMMIT_NCS_RECONCILE_ATTACH_NON_SERVICE_CONFIG
COMMIT_NCS_RECONCILE_DETACH_NON_SERVICE_CONFIG
COMMIT_NCS_CONFIRM_NETWORK_STATE
COMMIT_NCS_CONFIRM_NETWORK_STATE_RE_EVALUATE_POLICIES
COMMIT_NCS_CONFIRM_NETWORK_STATE_RE_DEPLOY_ALL

apply_params(...)

Method:

apply_params(self, keep_open=True, params=None)

Apply the transaction and return the result in form of dict().

The 'params' argument represent commit parameters. See CommitParams class for available commit parameters.

The result is a dictionary representing the result of applying transaction. If dry-run was requested, then the resulting dictionary will have 'dry-run' key set along with the actual results. If commit through commit queue was requested, then the resulting dictionary will have 'commit-queue' key set. Otherwise the dictionary will be empty.

Arguments:

keep_open -- keep transaction open (boolean)
params -- list of commit parameters (maapi.CommitParams)

Returns:

dict (see above)

Example use:

with ncs.maapi.single_write_trans('admin', 'python') as t:
    root = ncs.maagic.get_root(t)
    dns_list = root.devices.device['ex1'].config.sys.dns.server
    dns_list.create('192.0.2.1')
    params = t.get_params()
    params.dry_run_native()
    result = t.apply_params(True, params)
    print(result['device']['ex1'])
    t.apply_params(True, t.get_params())

commit(...)

Method:

commit(self)

Commit the transaction.

end_progress_span(...)

Method:

end_progress_span(self, *args)

Don't call this function.

Call instance.end() on the progress.Span instance created from start_progress_span() instead.

finish(...)

Method:

finish(self)

Finish the transaction.

This will finish the transaction. If the transaction is implemented by an external database, this will invoke the finish() callback.

get_params(...)

Method:

get_params(self)

Get the current commit parameters for the transaction.

The result is an instance of the CommitParams class.

hide_group(...)

Method:

hide_group(self, group_name)

Do hide a hide group.

Hide all nodes belonging to a hide group in a transaction that started with flag FLAG_HIDE_ALL_HIDEGROUPS.

prepare(...)

Method:

prepare(self, flags=0)

Prepare transaction.

This function must be called as first part of two-phase commit. After this function has been called, commit() or abort() must be called.

It will invoke the prepare callback in all participants in the transaction. If all participants reply with OK, the second phase of the two-phase commit procedure is commenced.

Arguments:

flags - additional transaction flags (int)

Flags (maapi):

COMMIT_NCS_NO_REVISION_DROP
COMMIT_NCS_NO_DEPLOY
COMMIT_NCS_NO_NETWORKING
COMMIT_NCS_NO_OUT_OF_SYNC_CHECK
COMMIT_NCS_NO_OVERWRITE_WRITE_SET_ONLY
COMMIT_NCS_NO_OVERWRITE_WRITE_AND_FULL_READ_SET
COMMIT_NCS_NO_OVERWRITE_WRITE_AND_SERVICE_READ_SET
COMMIT_NCS_USE_LSA
COMMIT_NCS_NO_LSA
COMMIT_NCS_RECONCILE_KEEP_NON_SERVICE_CONFIG
COMMIT_NCS_RECONCILE_DISCARD_NON_SERVICE_CONFIG
COMMIT_NCS_RECONCILE_ATTACH_NON_SERVICE_CONFIG
COMMIT_NCS_RECONCILE_DETACH_NON_SERVICE_CONFIG
COMMIT_NCS_CONFIRM_NETWORK_STATE
COMMIT_NCS_CONFIRM_NETWORK_STATE_RE_EVALUATE_POLICIES
COMMIT_NCS_CONFIRM_NETWORK_STATE_RE_DEPLOY_ALL

progress_info(...)

Method:

progress_info(self, msg, verbosity=0, attrs=None, links=None, path=None)

Arguments:

msg - message to report (str)
verbosity - ncs.VERBOSITY_*, VERBOSITY_NORMAL is default (optional)
attrs - user defined attributes (optional)
links - list of ncs.progress.Span or dict (optional)
path - keypath to an action/leaf/service/etc (str, optional)

start_progress_span(...)

Method:

start_progress_span(self, msg, verbosity=0, attrs=None, links=None, path=None)

Starts a progress span. Progress spans are trace messages written to the progress trace and the developer log. A progress span consists of a start and a stop event which can be used to calculate the duration between the two. Those events can be identified with unique span-id. Inside the span it is possible to start new spans, which will then become child spans, the parent-span-id is set to the previous spans' span-id. A child span can be used to calculate the duration of a sub task, and is started from consecutive maapi_start_progress_span() calls, and is ended with maapi_end_progress_span().

The function returns a Span object which either stops the span by invoking span.end() or by exiting a 'with' context. Messages are written to the progress trace which can be directed to a file, oper data or as notifications.

Call help(ncs.progress) or help(confd.progress) for examples.

Arguments:

msg - message to report (str)
verbosity - ncs.VERBOSITY_*, VERBOSITY_NORMAL is default (optional)
attrs - user defined attributes (optional)
links - list of ncs.progress.Span or dict (optional)
path - keypath to an action/leaf/service/etc (str, optional)

Returns:

trace span (ncs.progress.Span)

unhide_group(...)

Method:

unhide_group(self, group_name)

Do unhide a hide group.

Unhide all nodes belonging to a hide group in a transaction that started with flag FLAG_HIDE_ALL_HIDEGROUPS.

validate(...)

Method:

validate(self, unlock, forcevalidation=False)

Validate the transaction.

This function validates all data written in the transaction. This includes all data model constraints and all defined semantic validation, i.e. user programs that have registered functions under validation points.

If 'unlock' is True, the transaction is open for further editing even if validation succeeds. If 'unlock' is False and the function succeeds next function to be called MUST be prepare() or finish().

'unlock = True' can be used to implement a 'validate' command which can be given in the middle of an editing session. The first thing that happens is that a lock is set. If 'unlock' == False, the lock is released on success. The lock is always released on failure.

The 'forcevalidation' argument should normally be False. It has no effect for a transaction towards the running or startup data stores, validation is always performed. For a transaction towards the candidate data store, validation will not be done unless 'forcevalidation' is True. Avoiding this validation is preferable if we are going to commit the candidate to running, since otherwise the validation will be done twice. However if we are implementing a 'validate' command, we should give a True value for 'forcevalidation'.

Arguments:

unlock (boolean)
forcevalidation (boolean)

Predefined Values

CMD_KEEP_PIPE = 8
CMD_NO_AAA = 4
CMD_NO_FULLPATH = 1
CMD_NO_HIDDEN = 2
COMMIT_NCS_ASYNC_COMMIT_QUEUE = 256
COMMIT_NCS_BYPASS_COMMIT_QUEUE = 64
COMMIT_NCS_CONFIRM_NETWORK_STATE = 268435456
COMMIT_NCS_CONFIRM_NETWORK_STATE_RE_DEPLOY_ALL = 8589934592
COMMIT_NCS_CONFIRM_NETWORK_STATE_RE_EVALUATE_POLICIES = 536870912
COMMIT_NCS_CONFIRM_NETWORK_STATE_WRITE_AND_SERVICE_READ_SET = 4294967296
COMMIT_NCS_NO_DEPLOY = 8
COMMIT_NCS_NO_FASTMAP = 8
COMMIT_NCS_NO_LSA = 1048576
COMMIT_NCS_NO_NETWORKING = 16
COMMIT_NCS_NO_OUT_OF_SYNC_CHECK = 32
COMMIT_NCS_NO_OVERWRITE = 1024
COMMIT_NCS_NO_OVERWRITE_WRITE_AND_FULL_READ_SET = 1073741824
COMMIT_NCS_NO_OVERWRITE_WRITE_AND_SERVICE_READ_SET = 2147483648
COMMIT_NCS_NO_REVISION_DROP = 4
COMMIT_NCS_RECONCILE_ATTACH_NON_SERVICE_CONFIG = 67108864
COMMIT_NCS_RECONCILE_DETACH_NON_SERVICE_CONFIG = 134217728
COMMIT_NCS_RECONCILE_DISCARD_NON_SERVICE_CONFIG = 33554432
COMMIT_NCS_RECONCILE_KEEP_NON_SERVICE_CONFIG = 16777216
COMMIT_NCS_SYNC_COMMIT_QUEUE = 512
COMMIT_NCS_USE_LSA = 524288
CONFIG_AUTOCOMMIT = 8192
CONFIG_C = 4
CONFIG_CDB_ONLY = 4194304
CONFIG_CONTINUE_ON_ERROR = 16384
CONFIG_C_IOS = 32
CONFIG_HIDE_ALL = 2048
CONFIG_J = 2
CONFIG_JSON = 131072
CONFIG_MERGE = 64
CONFIG_NO_BACKQUOTE = 2097152
CONFIG_NO_PARENTS = 524288
CONFIG_OPER_ONLY = 1048576
CONFIG_READ_WRITE_ACCESS_ONLY = 33554432
CONFIG_REPLACE = 1024
CONFIG_SHOW_DEFAULTS = 16
CONFIG_SUPPRESS_ERRORS = 32768
CONFIG_TURBO_C = 8388608
CONFIG_UNHIDE_ALL = 4096
CONFIG_WITH_DEFAULTS = 8
CONFIG_WITH_OPER = 128
CONFIG_WITH_SERVICE_META = 262144
CONFIG_XML = 1
CONFIG_XML_LOAD_LAX = 65536
CONFIG_XML_PRETTY = 512
CONFIG_XPATH = 256
DEL_ALL = 2
DEL_EXPORTED = 3
DEL_SAFE = 1
ECHO = 1
FLAG_CONFIG_CACHE_ONLY = 32
FLAG_CONFIG_ONLY = 4
FLAG_DELAYED_WHEN = 64
FLAG_DELETE = 2
FLAG_DIFFSTYLE = 2
FLAG_EMIT_PARENTS = 1
FLAG_HIDE_ALL_HIDEGROUPS = 256
FLAG_HIDE_INACTIVE = 8
FLAG_HINT_BULK = 1
FLAG_NON_RECURSIVE = 4
FLAG_NO_BRIEF = 1
FLAG_NO_CONFIG_CACHE = 16
FLAG_NO_DEFAULTS = 2
FLAG_SKIP_SUBSCRIBERS = 512
LOAD_SCHEMAS_LOAD = True
LOAD_SCHEMAS_RELOAD = 2
LOAD_SCHEMAS_SKIP = False
MOVE_AFTER = 3
MOVE_BEFORE = 2
MOVE_FIRST = 1
MOVE_LAST = 4
NOECHO = 0
PRODUCT = 'NCS'
UPGRADE_KILL_ON_TIMEOUT = 1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Python ncs.maapi Module

Functions

connect

retry_on_conflict

single_read_trans

single_write_trans

Classes

class CommitParams

class ConfirmNetworkStateMode

class ConfirmNetworkStateScope

class DryRunOutformat

class Key

class Maapi

class NoOverwriteScope

class Session

class TemplateTypes

class Transaction

Predefined Values

Uh oh!

FilesExpand file tree

ncs.maapi.md

Latest commit

History

ncs.maapi.md

File metadata and controls

Python ncs.maapi Module

Functions

connect

retry_on_conflict

single_read_trans

single_write_trans

Classes

class CommitParams

class ConfirmNetworkStateMode

class ConfirmNetworkStateScope

class DryRunOutformat

class Key

class Maapi

class NoOverwriteScope

class Session

class TemplateTypes

class Transaction

Predefined Values