jnpr.junos.cfg.resource¶

class jnpr.junos.cfg.resource.Resource(junos, namevar=None, **kvargs)[source]¶

Bases: object

D¶

returns the Device object bound to this resource/manager

M¶

returns the :Resource: manager associated to this resource

P¶

returns the parent of the associated Junos object

PROPERTIES = ['_exists', '_active']¶

R¶

returns the Device RPC meta object

__init__(junos, namevar=None, **kvargs)[source]¶

Resource or Resource-Manager constructor. All managed resources and resource-managers inherit from this class.

junos

Instance of Device, this is bound to the Resource for device access

namevar

If not None, identifies a specific resource by ‘name’. The format of the name is resource dependent. Most resources take a single string name, while others use tuples for compound names. refer to each resource for the ‘namevar’ definition

If namevar is None, then the instance is a Resource-Manager (RM). The RM is then used to select specific resources by name using the __getitem__ overload.

kvargs[‘P’] or kvargs[‘parent’]

Instance to the resource parent. This is set when resources have hierarchical relationships, like rules within rulesets

kvargs[‘M’]

Instance to the resource manager.

activate()[source]¶

activate resource in Junos config the same as the Junos config-mode “activate” command

active¶

is this resource configuration active on the Junos device?

RuntimeError:	if invoked on a manager object

catalog¶

returns a dictionary of resources

catalog_refresh()[source]¶

reloads the resource catalog from the Junos device

classmethod copyifexists(xml, ele_name, to_py, py_name=None)[source]¶

deactivate()[source]¶

activate resource in Junos config the same as the Junos config-mode “deactivate” command

delete()[source]¶

remove configuration from Junos device the same as the Junos config-mode “delete” command

classmethod diff_list(has_list, should_list)[source]¶

exists¶

does this resource configuration exist on the Junos device?

RuntimError:	if invoked on a manager

is_mgr¶

is this a resource manager?

is_new¶

is this a new resource? that is, it does not exist on the Junos device when it was initally retrieved

RuntimeError:	if invoked on a manager

list¶

returns a list of named resources

list_refresh()[source]¶

reloads the managed resource list from the Junos device

manages¶

a resource may contain sub-managers for hierarchical oriented resources. this method will return a list of manager names attached to this resource, or :None: if there are not any

name¶

the name of the resource

RuntimeError:	if invoked on a manager

propcopy(p_name)[source]¶

proptery from :has: to :should:

performs a ‘deepcopy’ of the property; used to make changes to list, dict type properties

read()[source]¶

read resource configuration from device

refresh()[source]¶

rename(new_name)[source]¶

rename resource in Junos configuration the same as the Junos config-mode “rename” command

reorder(**kvargs)[source]¶

move the configuration within the Junos hierarcy the same as the Junos config-mode “insert” command

Kvargs:	after=”<name>” before=”<name>”

write(**kvargs)[source]¶

write resource configuration stored in :should: back to device

kvargs[‘touch’]

if True, then write() will skip the check to see if any items exist in :should:

xml¶

for debugging the resource XML configuration that was read from the Junos device

classmethod xml_set_or_delete(xml, ele_name, value)[source]¶

HELPER function to either set a value or remove the element

classmethod xmltag_set_or_del(ele_name, value)[source]¶

HELPER function creates an XML element tag read-only that includes the DEL attribute depending on :value:

jnpr.junos.cfg.user¶

class jnpr.junos.cfg.user.User(junos, namevar=None, **kvargs)[source]¶

Bases: jnpr.junos.cfg.resource.Resource

[edit system login user <name>]

Resource name: str

<name> is the user login name

Manages resources:

sshkey, UserSSHKey

MANAGES = {'sshkey': <class 'jnpr.junos.cfg.user_ssh_key.UserSSHKey'>}¶

PROPERTIES = ['uid', 'fullname', 'userclass', 'password', '$password', '$sshkeys']¶

jnpr.junos.cfg.user_ssh_key¶

class jnpr.junos.cfg.user_ssh_key.UserSSHKey(junos, namevar=None, **kvargs)[source]¶

Bases: jnpr.junos.cfg.resource.Resource

[edit system login user <name> authentication <key-type> <key-value> ]

Resource name: tuple(<key-type>, <key-value>)

<key-type> : [‘ssh-dsa’, ‘ssh-rsa’] <key-value> : SSH public key string (usually something very long)

Resource manager utilities:

load_key - allows you to load an ssh-key from a file or str

PROPERTIES = []¶

load_key(path=None, key_value=None)[source]¶

Adds a new ssh-key to the user authentication. You can provide either the path to the ssh-key file, or the contents of they key (useful for loading the same key on many devices)

Path:	(optional) path to public ssh-key file on the local server,
Key_value:	(optional) the contents of the ssh public key

jnpr.junos.factory.cfgtable¶

class jnpr.junos.factory.cfgtable.CfgTable(dev=None, xml=None, path=None, mode=None)[source]¶

Bases: jnpr.junos.factory.table.Table

__init__(dev=None, xml=None, path=None, mode=None)[source]¶

Dev:	Device instance
Xml:	lxml Element instance
Path:	file path to XML, to be used rather than :dev:

append()[source]¶

It creates lxml nodes with field name as xml tag and its value given by user as text of xml node. The generated xml nodes are appended to configuration xml at appropriate hierarchy.

Warning

xml node that are appended cannot be changed later hence care should be taken to assign correct value to table fields before calling append.

get(*vargs, **kvargs)[source]¶

Retrieve configuration data for this table. By default all child keys of the table are loaded. This behavior can be overridden by with kvargs[‘nameonly’]=True

Parameters:	vargs[0] (str) – identifies a unique item in the table, same as calling with :kvargs[‘key’]: value namesonly (str) – OPTIONAL True/False*, when set to True will cause only the the name-keys to be retrieved. key (str) – OPTIONAL identifies a unique item in the table options (dict) – OPTIONAL options to pass to get-configuration. By default {‘inherit’: ‘inherit’, ‘groups’: ‘groups’} is sent.

get_table_xml()[source]¶

It returns lxml object of configuration xml that is generated from table data (field=value) pairs. To get a valid xml this method should be used after append() is called.

keys_required¶

True/False - if this Table requires keys

load(**kvargs)[source]¶

Load configuration xml having table data (field=value) in candidate db. This method should be used after append() is called to get the desired results.

Parameters:	overwrite (bool) – Determines if the contents completely replace the existing configuration. Default is False. merge (bool) – If set to True will set the load-config action to merge. the default load-config action is ‘replace’
Returns:	Class object.
Raises:	ConfigLoadError: When errors detected while loading configuration. You can use the Exception errs variable to identify the specific problems RuntimeError: If field value is set and append() is not invoked before calling this method, it will raise an exception with appropriate error message.

required_keys¶

return a list of the keys required when invoking :get(): and :get_keys():

reset()[source]¶

Initialize fields of set table to it’s default value (if mentioned in Table/View) else set to None.

set(**kvargs)[source]¶

Load configuration data in running db. It performs following operation in sequence.

• lock(): Locks candidate configuration db.
• load(): Load structured configuration xml in candidate db.
• commit(): Commit configuration to runnning db.
• unlock(): Unlock candidate db.

This method should be used after append() is called to get the desired results.

Parameters:	overwrite (bool) – Determines if the contents completely replace the existing configuration. Default is False. merge (bool) – If set to True will set the load-config action to merge. the default load-config action is ‘replace’ comment (str) – If provided logs this comment with the commit. confirm (int) – If provided activates confirm safeguard with provided value as timeout (minutes). timeout (int) – If provided the command will wait for completion using the provided value as timeout (seconds). By default the device timeout is used. sync (bool) – On dual control plane systems, requests that the candidate configuration on one control plane be copied to the other control plane, checked for correct syntax, and committed on both Routing Engines. force_sync (bool) – On dual control plane systems, forces the candidate configuration on one control plane to be copied to the other control plane. full (bool) – When true requires all the daemons to check and evaluate the new configuration. detail (bool) – When true return commit detail as XML
Returns:	Class object:
Raises:	ConfigLoadError: When errors detected while loading configuration. You can use the Exception errs variable to identify the specific problems CommitError: When errors detected in candidate configuration. You can use the Exception errs variable to identify the specific problems RuntimeError: If field value is set and append() is not invoked before calling this method, it will raise an exception with appropriate error message.

Warning

If the function does not receive a reply prior to the timeout a RpcTimeoutError will be raised. It is possible the commit was successful. Manual verification may be required.

jnpr.junos.factory.factory_cls¶

jnpr.junos.factory.factory_cls.FactoryCfgTable(table_name=None, data_dict={})[source]¶

jnpr.junos.factory.factory_cls.FactoryOpTable(cmd, args=None, args_key=None, item=None, key='name', view=None, table_name=None)[source]¶

jnpr.junos.factory.factory_cls.FactoryTable(item, key='name', view=None, table_name=None)[source]¶

jnpr.junos.factory.factory_cls.FactoryView(fields, **kvargs)[source]¶

Fields:	dictionary of fields, structure of which is ~internal~ and should not be defined explicitly. use the RunstatMaker.Fields() mechanism to create theserather than hardcoding the dictionary structures; since they might change over time.
Kvargs:	‘view_name’ to name the class. this could be useful for debug or eventual callback mechanisms. ‘groups’ is a dict of name/xpath assocaited to fields this technique would be used to extract fields from node-set elements like port <if-device-flags>. ‘extends’ names the base View class to extend. using this technique you can add to existing defined Views.

jnpr.junos.factory.factory_loader¶

This file contains the FactoryLoader class that is used to dynamically create Runstat Table and View objects from a <dict> of data. The <dict> can originate from any kind of source: YAML, JSON, program. For examples of YAML refer to the .yml files in this jnpr.junos.op directory.

class jnpr.junos.factory.factory_loader.FactoryLoader[source]¶

Bases: object

Used to load a <dict> of data that contains Table and View definitions.

The primary method is :load(): which will return a <dict> of item-name and item-class definitions.

If you want to import these definitions directly into your namespace, (like a module) you would do the following:

loader = FactoryLoader() catalog = loader.load( <catalog_dict> ) globals().update( catalog )

If you did not want to do this, you can access the items as the catalog. For example, if your <catalog_dict> contained a Table called MyTable, then you could do something like:

MyTable = catalog[‘MyTable’] table = MyTable(dev) table.get() …

__init__()[source]¶

x.__init__(…) initializes x; see help(type(x)) for signature

load(catalog_dict, envrion={})[source]¶

jnpr.junos.factory.optable¶

class jnpr.junos.factory.optable.OpTable(dev=None, xml=None, path=None)[source]¶

Bases: jnpr.junos.factory.table.Table

get(*vargs, **kvargs)[source]¶

Retrieve the XML table data from the Device instance and returns back the Table instance - for call-chaining purposes.

If the Table was created with a :path: rather than a Device, then this method will load the XML from that file. In this case, the *vargs, and **kvargs are not used.

ALIAS: __call__

Vargs:	[0] is the table :arg_key: value. This is used so that the caller can retrieve just one item from the table without having to know the Junos RPC argument.
Kvargs:	these are the name/value pairs relating to the specific Junos XML command attached to the table. For example, if the RPC is ‘get-route-information’, there are parameters such as ‘table’ and ‘destination’. Any valid RPC argument can be passed to :kvargs: to further filter the results of the :get(): operation. neato!

NOTES:

If you need to create a ‘stub’ for unit-testing purposes, you want to create a subclass of your table and overload this methods.

jnpr.junos.factory.table¶

class jnpr.junos.factory.table.Table(dev=None, xml=None, path=None)[source]¶

Bases: object

D¶

the Device instance

ITEM_NAME_XPATH = 'name'¶

ITEM_XPATH = None¶

RPC¶

the Device.rpc instance

VIEW = None¶

__init__(dev=None, xml=None, path=None)[source]¶

Dev:	Device instance
Xml:	lxml Element instance
Path:	file path to XML, to be used rather than :dev:

get(*vargs, **kvargs)[source]¶

hostname¶

is_container¶

True if this table does not have records, but is a container of fields False otherwise

items()[source]¶

returns list of tuple(name,values) for each table entry

key_list¶

the list of keys, as property for caching

keys()[source]¶

savexml(path, hostname=False, timestamp=False, append=None)[source]¶

Save a copy of the table XML data to a local file. The name of the output file (:path:) can include the name of the Device host, the timestamp of this action, as well as any user-defined appended value. These ‘add-ons’ will be added to the :path: value prior to the file extension in the order (hostname,timestamp,append), separated by underscore (_).

For example, if both hostname=True and append=’BAZ1’, then when :path: = ‘/var/tmp/foo.xml’ and the Device.hostname is “srx123”, the final file-path will be “/var/tmp/foo_srx123_BAZ1.xml”

Path:	file-path to write the XML file on the local filesystem
Hostname:	if True, will append the hostname to the :path:
Timestamp:	if True, will append the timestamp to the :path: using the default timestamp format if <str> the timestamp will use the value as the timestamp format as defied by strftime()
Append:	any <str> value that you’d like appended to the :path: value preceding the filename extension.

to_json()[source]¶

Returns:	JSON encoded string of entire Table contents

values()[source]¶

returns list of table entry items()

view¶

returns the current view assigned to this table

jnpr.junos.factory.view¶

class jnpr.junos.factory.view.View(table, view_xml)[source]¶

Bases: object

View is the base-class that makes extracting values from XML data appear as objects with attributes.

D¶

return the Device instance for this View

FIELDS = {}¶

GROUPS = None¶

ITEM_NAME_XPATH = 'name'¶

T¶

return the Table instance for the View

__init__(table, view_xml)[source]¶

Table:	instance of the RunstatTable
View_xml:	this should be an lxml etree Elemenet object. This constructor also accepts a list with a single item/XML

asview(view_cls)[source]¶

create a new View object for this item

items()[source]¶

list of tuple(key,value)

key¶

return the name of view item

keys()[source]¶

list of view keys, i.e. field names

name¶

return the name of view item

refresh()[source]¶

~~~ EXPERIMENTAL ~~~ refresh the data from the Junos device. this only works if the table provides an “args_key”, does not update the original table, just this specific view/item

to_json()[source]¶

Returns:	JSON encoded string of entire View contents

updater(**kwds)[source]¶

provide the ability for subclassing objects to extend the definitions of the fields. this is implemented as a context manager with the form called from the subclass constructor:

with self.extend() as more:

more.fields = <dict> more.groups = <dict> # optional

values()[source]¶

list of view values

xml¶

returns the XML associated to the item

jnpr.junos.factory.viewfields¶

class jnpr.junos.factory.viewfields.ViewFields[source]¶

Bases: object

Used to dynamically create a field dictionary used with the RunstatView class

__init__()[source]¶

x.__init__(…) initializes x; see help(type(x)) for signature

astype(name, xpath=None, astype=<type 'int'>, **kvargs)[source]¶

field string value will be passed to function :astype:

This is typically used to do simple type conversions, but also works really well if you set :astype: to a function that does a basic converstion like look at the value and change it to a True/False. For example:

astype=lambda x: True if x == ‘enabled’ else False

end¶

flag(name, xpath=None, **kvargs)[source]¶

field is a flag, results in True/False if the xpath element exists or not. Model this as a boolean type <bool>

group(name, xpath=None, **kvargs)[source]¶

field is an apply group, results in value of group attr if the xpath element has the associated group attribute.

int(name, xpath=None, **kvargs)[source]¶

field is an integer

str(name, xpath=None, **kvargs)[source]¶

field is a string

table(name, table)[source]¶

field is a RunstatTable

Module contents¶

jnpr.junos.factory.loadyaml(path)[source]¶

Load a YAML file at :path: that contains Table and View definitions. Returns a <dict> of item-name anditem-class definition.

If you want to import these definitions directly into your namespace, (like a module) you would do the following:

globals().update( loadyaml( <path-to-yaml-file> ))

If you did not want to do this, you can access the items as the <dict>. For example, if your YAML file contained a Table called MyTable, then you could do something like:

catalog = loadyaml( <path-to-yaml-file> ) MyTable = catalog[‘MyTable’]

table = MyTable(dev) table.get() …

class jnpr.junos.factory.FactoryLoader[source]¶

Bases: object

Used to load a <dict> of data that contains Table and View definitions.

The primary method is :load(): which will return a <dict> of item-name and item-class definitions.

If you want to import these definitions directly into your namespace, (like a module) you would do the following:

loader = FactoryLoader() catalog = loader.load( <catalog_dict> ) globals().update( catalog )

If you did not want to do this, you can access the items as the catalog. For example, if your <catalog_dict> contained a Table called MyTable, then you could do something like:

MyTable = catalog[‘MyTable’] table = MyTable(dev) table.get() …

__init__()[source]¶

x.__init__(…) initializes x; see help(type(x)) for signature

load(catalog_dict, envrion={})[source]¶

jnpr.junos.op.arp¶

Pythonifier for ARP Table/View

jnpr.junos.op.bfd¶

Pythonifier for BFD Table/View

jnpr.junos.op.ethport¶

Pythonifier for EthPort Table/View

jnpr.junos.op.isis¶

Pythonifier for ISIS Table/View

jnpr.junos.op.lacp¶

Pythonifier for LACP Table/View

jnpr.junos.op.ldp¶

Pythonifier for LDP Table/View

jnpr.junos.op.lldp¶

Pythonifier for LLDP Table/View

jnpr.junos.op.phyport¶

Pythonifier for PhyPort Table/View

jnpr.junos.op.routes¶

Pythonifier for Route Table/View

jnpr.junos.op.xcvr¶

Pythonifier for Xcvr Table/View

jnpr.junos.resources.autosys¶

Pythonifier for AutoSys Table/View

jnpr.junos.resources.bgp¶

Pythonifier for BGP Table/View

jnpr.junos.resources.staticroutes¶

Pythonifier for Static route Table/View

jnpr.junos.resources.syslog¶

Pythonifier for Syslog Table/View

jnpr.junos.resources.user¶

Pythonifier for User Table/View

jnpr.junos.utils.config¶

class jnpr.junos.utils.config.Config(dev, mode=None, **kwargs)[source]¶

Bases: jnpr.junos.utils.util.Util

Overview of Configuration Utilities.

• commit(): commit changes
• commit_check(): perform the commit check operation
• diff(): return the diff string between running and candidate config
• load(): load changes into the candidate config
• lock(): take an exclusive lock on the candidate config
• pdiff(): prints the diff string (debug/helper)
• rescue(): controls “rescue configuration”
• rollback(): perform the load rollback command
• unlock(): release the exclusive lock

__init__(dev, mode=None, **kwargs)[source]¶

Parameters:	mode (str) – Can be used only when creating Config object using context manager ”private” - Work in private database ”dynamic” - Work in dynamic database ”batch” - Work in batch database ”exclusive” - Work with Locking the candidate configuration ”ephemeral” - Work in default/specified ephemeral instance ephemeral_instance (str) – ephemeral instance name

# mode can be private/dynamic/exclusive/batch/ephemeral
with Config(dev, mode='exclusive') as cu:
    cu.load('set system services netconf traceoptions file xyz',
            format='set')
    print cu.diff()
    cu.commit()

Warning

Ephemeral databases are an advanced Junos feature which if used incorrectly can have serious negative impact on the operation of the Junos device. We recommend you consult JTAC and/or you Juniper account team before deploying the ephemeral database feature in your network.

commit(**kvargs)[source]¶

Commit a configuration.

Parameters:	comment (str) – If provided logs this comment with the commit. confirm (int) – If provided activates confirm safeguard with provided value as timeout (minutes). timeout (int) – If provided the command will wait for completion using the provided value as timeout (seconds). By default the device timeout is used. sync (bool) – On dual control plane systems, requests that the candidate configuration on one control plane be copied to the other control plane, checked for correct syntax, and committed on both Routing Engines. force_sync (bool) – On dual control plane systems, forces the candidate configuration on one control plane to be copied to the other control plane. full (bool) – When true requires all the daemons to check and evaluate the new configuration. detail (bool) – When true return commit detail as XML ignore_warning – A boolean, string or list of string. If the value is True, it will ignore all warnings regardless of the warning message. If the value is a string, it will ignore warning(s) if the message of each warning matches the string. If the value is a list of strings, ignore warning(s) if the message of each warning matches at least one of the strings in the list. For example: cu.commit(ignore_warning=True) cu.commit(ignore_warning='Advertisement-interval is ' 'less than four times') cu.commit(ignore_warning=['Advertisement-interval is ' 'less than four times', 'Chassis configuration for network ' 'services has been changed.']) Note When the value of ignore_warning is a string, or list of strings, the string is actually used as a case-insensitive regular expression pattern. If the string contains only alpha-numeric characters, as shown in the above examples, this results in a case-insensitive substring match. However, any regular expression pattern supported by the re library may be used for more complicated match conditions.
Returns:	True when successful Commit detail XML (when detail is True)
Raises:	CommitError – When errors detected in candidate configuration. You can use the Exception errs variable to identify the specific problems

Warning

If the function does not receive a reply prior to the timeout a RpcTimeoutError will be raised. It is possible the commit was successful. Manual verification may be required.

commit_check()[source]¶

Perform a commit check. If the commit check passes, this function will return True. If the commit-check results in warnings, they are reported and available in the Exception errs.

Returns:	True if commit-check is successful (no errors)
Raises:	CommitError – When errors detected in candidate configuration. You can use the Exception errs variable to identify the specific problems RpcError – When underlying ncclient has an error

diff(rb_id=0)[source]¶

Retrieve a diff (patch-format) report of the candidate config against either the current active config, or a different rollback.

Parameters:	rb_id (int) – rollback id [0..49]
Returns:	None if there is no difference ascii-text (str) if there is a difference

load(*vargs, **kvargs)[source]¶

Loads changes into the candidate configuration. Changes can be in the form of strings (text,set,xml, json), XML objects, and files. Files can be either static snippets of configuration or Jinja2 templates. When using Jinja2 Templates, this method will render variables into the templates and then load the resulting change; i.e. “template building”.

Parameters:	vargs[0] (object) – The content to load. If the contents is a string, the framework will attempt to automatically determine the format. If it is unable to determine the format then you must specify the format parameter. If the content is an XML object, then this method assumes you’ve structured it correctly; and if not an Exception will be raised. path (str) – Path to file of configuration on the local server. The path extension will be used to determine the format of the contents: ”conf”,”text”,”txt” is curly-text-style ”set” - ascii-text, set-style ”xml” - ascii-text, XML ”json” - ascii-text, json Note The format can specifically set using format. format (str) – Determines the format of the contents. Refer to options from the path description. overwrite (bool) – Determines if the contents completely replace the existing configuration. Default is False. Note This option cannot be used if format is “set”. merge (bool) – If set to True will set the load-config action to merge. the default load-config action is ‘replace’ update (bool) – If set to True Compare a complete loaded configuration against the candidate configuration. For each hierarchy level or configuration object that is different in the two configurations, the version in the loaded configuration replaces the version in the candidate configuration. When the configuration is later committed, only system processes that are affected by the changed configuration elements parse the new configuration. Note This option cannot be used if format is “set”. template_path (str) – Similar to the path parameter, but this indicates that the file contents are Jinja2 format and will require template-rendering. Note This parameter is used in conjunction with template_vars. The template filename extension will be used to determine the format-style of the contents, or you can override using format. template (jinja2.Template) – A Jinja2 Template object. Same description as template_path, except this option you provide the actual Template, rather than a path to the template file. template_vars (dict) – Used in conjunction with the other template options. This parameter contains a dictionary of variables to render into the template. ignore_warning – A boolean, string or list of string. If the value is True, it will ignore all warnings regardless of the warning message. If the value is a string, it will ignore warning(s) if the message of each warning matches the string. If the value is a list of strings, ignore warning(s) if the message of each warning matches at least one of the strings in the list. For example: cu.load(cnf, ignore_warning=True) cu.load(cnf, ignore_warning='statement not found') cu.load(cnf, ignore_warning=['statement not found', 'statement has no contents; ignored') Note When the value of ignore_warning is a string, or list of strings, the string is actually used as a case-insensitive regular expression pattern. If the string contains only alpha-numeric characters, as shown in the above examples, this results in a case-insensitive substring match. However, any regular expression pattern supported by the re library may be used for more complicated match conditions. url (str) – Specify the full pathname of the file that contains the configuration data to load. The value can be a local file path, an FTP location, or a Hypertext Transfer Protocol (HTTP). Refer Doc page for more details. For example: cu.load(url="/var/home/user/golden.conf") cu.load(url="ftp://username@ftp.hostname.net/filename") cu.load(url="http://username:password@hostname/path/filename") cu.load(url="/var/home/user/golden.conf", overwrite=True)
Returns:	RPC-reply as XML object.
Raises:	ConfigLoadError: When errors detected while loading candidate configuration. You can use the Exception errs variable to identify the specific problems.

lock()[source]¶

Attempts an exclusive lock on the candidate configuration. This is a non-blocking call.

Returns:	True always when successful
Raises:	LockError – When the lock cannot be obtained

pdiff(rb_id=0)[source]¶

Helper method that calls print on the diff (patch-format) between the current candidate and the provided rollback.

Parameters:	rb_id (int) – the rollback id value [0-49]
Returns:	None

rescue(action, format='text')[source]¶

Perform action on the “rescue configuration”.

Parameters:	action (str) – identifies the action as follows: ”get” - retrieves/returns the rescue configuration via format ”save” - saves current configuration as rescue ”delete” - removes the rescue configuration ”reload” - loads the rescue config as candidate (no-commit) format (str) – identifies the return format when action is ”get”: ”text” (default) - ascii-text format ”xml” - as XML object
Returns:	When action is ‘get’, then the contents of the rescue configuration is returned in the specified format. If there is no rescue configuration saved, then the return value is None. True when action is “save”. True when action is “delete”. Note True regardless if a rescue configuration exists. When action is ‘reload’, return is True if a rescue configuration exists, and False otherwise. Note The rescue configuration is only loaded as the candidate, and not committed. You must commit to make the rescue configuration active.
Raises:	ValueError – If action is not one of the above

rollback(rb_id=0)[source]¶

Rollback the candidate config to either the last active or a specific rollback number.

Parameters:	rb_id (int) – The rollback id value [0-49], defaults to 0.
Returns:	True always when successful
Raises:	ValueError – When invalid rollback id is given

unlock()[source]¶

Unlocks the candidate configuration.

Returns:	True always when successful
Raises:	UnlockError – If you attempt to unlock a configuration when you do not own the lock

jnpr.junos.utils.fs¶

class jnpr.junos.utils.fs.FS(dev)[source]¶

Bases: jnpr.junos.utils.util.Util

Filesystem (FS) utilities:

• cat(): show the contents of a file
• checksum(): calculate file checksum (md5,sha256,sha1)
• cp(): local file copy (not scp)
• cwd(): change working directory
• ls(): return file/dir listing
• mkdir(): create a directory
• pwd(): get working directory
• mv(): local file rename
• rm(): local file delete
• rmdir(): remove a directory
• stat(): return file/dir information
• storage_usage(): return storage usage
• directory_usage(): return directory usage
• storage_cleanup(): perform storage storage_cleanup

• storage_cleanup_check(): returns a list of files which will be

  removed at cleanup

• symlink(): create a symlink
• tgz(): tar+gzip a directory

cat(path)[source]¶

Returns the contents of the file path.

Parameters:	path (str) – File-path
Returns:	contents of the file (str) or None if file does not exist

checksum(path, calc='md5')[source]¶

Performs the checksum command on the given file path using the required calculation method and returns the string value. If the path is not found on the device, then None is returned.

Parameters:	path (str) – file-path on local device calc (str) – checksum calculation method: ”md5” ”sha256” ”sha1”
Returns:	checksum value (str) or None if file not found

cp(from_path, to_path)[source]¶

Perform a local file copy where from_path and to_path can be any valid Junos path argument. Refer to the Junos “file copy” command documentation for details.

Parameters:	from_path (str) – source file-path to_path (str) – destination file-path

Returns:	True if OK, False if file does not exist.

cwd(path)[source]¶

Change working directory to path.

Parameters:	path (str) – path to working directory

directory_usage(path='.', depth=0)[source]¶

Returns the directory usage, similar to the unix “du” command.

Returns:	dict of directory usage, including subdirectories if depth > 0

ls(path='.', brief=False, followlink=True)[source]¶

File listing, returns a dict of file information. If the path is a symlink, then by default followlink will recursively call this method to obtain the symlink specific information.

Parameters:	path (str) – file-path on local device. defaults to current working directory brief (bool) – when True brief amount of data followlink (bool) – when True (default) this method will recursively follow the directory symlinks to gather data
Returns:	dict collection of file information or None if path is not found

mkdir(path)[source]¶

Executes the ‘mkdir -p’ command on path.

Warning

REQUIRES SHELL PRIVILEGES

Returns:	True if OK, error-message (str) otherwise

mv(from_path, to_path)[source]¶

Perform a local file rename function, same as “file rename” Junos CLI.

Returns:	True if OK, False if file does not exist.

pwd()[source]¶

Returns:	The current working directory path (str)

rm(path)[source]¶

Performs a local file delete action, per Junos CLI command “file delete”.

Returns:	True when successful, False otherwise.

rmdir(path)[source]¶

Executes the ‘rmdir’ command on path.

Warning

REQUIRES SHELL PRIVILEGES

Parameters:	path (str) – file-path to directory
Returns:	True if OK, error-message (str) otherwise

stat(path)[source]¶

Returns a dictionary of status information on the path, or None if the path does not exist.

Parameters:	path (str) – file-path on local device
Returns:	status information on the file
Return type:	dict

storage_cleanup()[source]¶

Perform the ‘request system storage cleanup’ command to remove files from the filesystem. Return a dict of file name/info on the files that were removed.

Returns:	dict on files that were removed

storage_cleanup_check()[source]¶

Perform the ‘request system storage cleanup dry-run’ command to return a dict of files/info that would be removed if the cleanup command was executed.

Returns:	dict of files that would be removed (dry-run)

storage_usage()[source]¶

Returns the storage usage, similar to the unix “df” command.

Returns:	dict of storage usage

symlink(from_path, to_path)[source]¶

Executes the ‘ln -sf from_path to_path’ command.

Warning

REQUIRES SHELL PRIVILEGES

Returns:	True if OK, or error-message (str) otherwise

tgz(from_path, tgz_path)[source]¶

Create a file called tgz_path that is the tar-gzip of the given directory specified from_path.

Parameters:	from_path (str) – file-path to directory of files tgz_path (str) – file-path name of tgz file to create
Returns:	True if OK, error-msg (str) otherwise

jnpr.junos.utils.scp¶

class jnpr.junos.utils.scp.SCP(junos, **scpargs)[source]¶

Bases: object

The SCP utility is used to conjunction with jnpr.junos.utils.sw.SW when transferring the Junos image to the device. The SCP can be used for other secure-copy use-cases as well; it is implemented to support the python context-manager pattern. For example:

from jnpr.junos.utils.scp import SCP

with SCP(dev, progress=True) as scp:
    scp.put(package, remote_path)

__init__(junos, **scpargs)[source]¶

Constructor that wraps paramiko and scp objects.

Parameters:	junos (Device) – the Device object scpargs (kvargs) – any additional args to be passed to paramiko SCP

close()[source]¶

Closes the ssh/scp connection to the device

open(**scpargs)[source]¶

Creates an instance of the scp object and return to caller for use.

Note

This method uses the same username/password authentication credentials as used by jnpr.junos.device.Device. It can also use ssh_private_key_file option if provided to the jnpr.junos.device.Device

Returns:	SCPClient object

jnpr.junos.utils.start_shell¶

class jnpr.junos.utils.start_shell.StartShell(nc, timeout=30)[source]¶

Bases: object

Junos shell execution utility. This utility is written to support the “context manager” design pattern. For example:

def _ssh_exec(self, command):
    with StartShell(self._dev) as sh:
        got = sh.run(command)
    return got

__init__(nc, timeout=30)[source]¶

Utility Constructor

Parameters:	nc (Device) – The Device object timeout (int) – Timeout value in seconds to wait for expected string/pattern.

close()[source]¶

Close the SSH client channel

open()[source]¶

Open an ssh-client connection and issue the ‘start shell’ command to drop into the Junos shell (csh). This process opens a paramiko.SSHClient instance.

run(command, this='(%|#)\\s', timeout=0)[source]¶

Run a shell command and wait for the response. The return is a tuple. The first item is True/False if exit-code is 0. The second item is the output of the command.

Parameters:

command (str) – the shell command to execute this (str) – the expected shell-prompt to wait for. If this is set to None, function will wait for all the output on the shell till timeout value. timeout (int) – Timeout value in seconds to wait for expected string/pattern (this). If not specified defaults to self.timeout. This timeout is specific to individual run call. If this is provided with None value, function will wait till timeout value to grab all the content from command output.

Returns:

(last_ok, result of the executed shell command (str) )

with StartShell(dev) as ss:
    print ss.run('cprod -A fpc0 -c "show version"', timeout=10)

Note

as a side-effect this method will set the self.last_ok property. This property is set to True if $? is “0”; indicating the last shell command was successful else False. If this is set to None, last_ok will be set to True if there is any content in result of the executed shell command.

send(data)[source]¶

Send the command data followed by a newline character.

Parameters:	data (str) – the data to write out onto the shell.
Returns:	result of SSH channel send

wait_for(this='(%|#)\\s', timeout=0)[source]¶

Wait for the result of the command, expecting this prompt.

Parameters:	this (str) – expected string/pattern. timeout (int) – Timeout value in seconds to wait for expected string/pattern. If not specified defaults to self.timeout.
Returns:	resulting string of data in a list
Return type:	list

Warning

need to add a timeout safeguard

jnpr.junos.utils.sw¶

class jnpr.junos.utils.sw.SW(dev)[source]¶

Bases: jnpr.junos.utils.util.Util

Software Utility class, used to perform a software upgrade and associated functions. These methods have been tested on simple deployments. Refer to install for restricted use-cases for software upgrades.

Primary methods:

• install(): perform the entire software installation process
• reboot(): reboots the system for the new image to take effect
• poweroff(): shutdown the system

Helpers: (Useful as standalone as well)

• put(): SCP put package file onto Junos device
• pkgadd(): performs the ‘request’ operation to install the package
• validate(): performs the ‘request’ to validate the package

Miscellaneous:

• rollback: same as ‘request software rollback’
• inventory: (property) provides file info for current and rollback images on the device

__init__(dev)[source]¶

x.__init__(…) initializes x; see help(type(x)) for signature

install(package=None, pkg_set=None, remote_path='/var/tmp', progress=None, validate=False, checksum=None, cleanfs=True, no_copy=False, issu=False, nssu=False, timeout=1800, cleanfs_timeout=300, checksum_timeout=300, checksum_algorithm='md5', force_copy=False, all_re=True, vmhost=False, **kwargs)[source]¶

Performs the complete installation of the package that includes the following steps:

1. If :package: is a URL, or :no_copy: is True, skip to step 8.
2. computes the checksum of :package: or :pgk_set: on the local host if :checksum: was not provided.
3. performs a storage cleanup on the remote Junos device if :cleanfs: is True
4. Attempts to compute the checksum of the :package: filename in the :remote_path: directory of the remote Junos device if the :force_copy: argument is False
5. SCP or FTP copies the :package: file from the local host to the :remote_path: directory on the remote Junos device under any of the following conditions:
   1. The :force_copy: argument is True
   2. The :package: filename doesn’t already exist in the :remote_path: directory of the remote Junos device.
   3. The checksum computed in step 2 does not match the checksum computed in step 4.
6. If step 5 was executed, computes the checksum of the :package: filename in the :remote_path: directory of the remote Junos device

7. Validates the checksum computed in step 2 matches the checksum

   computed in step 6.

8. validates the package if :validate: is True
9. installs the package

Warning

This process has been validated on the following deployments.

Tested:

• Single RE devices (EX, QFX, MX, SRX).
• MX dual-RE
• EX virtual-chassis when all same HW model
• QFX virtual-chassis when all same HW model
• QFX/EX mixed virtual-chassis
• Mixed mode VC

Known Restrictions:

• SRX cluster
• MX virtual-chassis

You can get a progress report on this process by providing a progress callback.

Note

You will need to invoke the reboot() method explicitly to reboot the device.

Parameters:

package (str) – Either the full file path to the install package tarball on the local (PyEZ host’s) filesystem OR a URL (from the target device’s perspcective) from which the device retrieves installed. When the value is a URL, then the :no_copy: and :remote_path: values are unused. The acceptable formats for a URL value may be found at: https://www.juniper.net/documentation/en_US/junos/topics/concept/junos-software-formats-filenames-urls.html pkg_set (list) – A list/tuple of :package: values which will be installed on a mixed VC setup. remote_path (str) – If the value of :package: or :pkg_set: is a file path on the local (PyEZ host’s) filesystem, then the image is copied from the local filesystem to the :remote_path: directory on the target Junos device. The default is /var/tmp. If the value of :package: or :pkg_set: is a URL, then the value of :remote_path: is unused. progress (func) – If provided, this is a callback function with a function prototype given the Device instance and the report string: def myprogress(dev, report): print "host: %s, report: %s" % (dev.hostname, report) If set to True, it uses sw.progress() for basic reporting by default. validate (bool) – When True this method will perform a config validation against the new image checksum (str) – hexdigest of the package file. If this is not provided, then this method will perform the calculation. If you are planning on using the same image for multiple updates, you should consider using the local_checksum() method to pre calculate this value and then provide to this method. cleanfs (bool) – When True will perform a ‘storage cleanup’ before copying the file to the device. Default is True. no_copy (bool) – When the value of :package: or :pkg_set is not a URL, and the value of :no_copy: is True the software package will not be copied to the device and is presumed to already exist on the :remote_path: directory of the target Junos device. When the value of :no_copy: is False (the default), then the package is copied from the local PyEZ host to the :remote_path: directory of the target Junos device. If the value of :package: or :pkg_set: is a URL, then the value of :no_copy: is unused. issu (bool) – (Optional) When True allows unified in-service software upgrade (ISSU) feature enables you to upgrade between two different Junos OS releases with no disruption on the control plane and with minimal disruption of traffic. nssu (bool) – (Optional) When True allows nonstop software upgrade (NSSU) enables you to upgrade the software running on a Juniper Networks EX Series Virtual Chassis or a Juniper Networks EX Series Ethernet Switch with redundant Routing Engines with a single command and minimal disruption to network traffic. timeout (int) – (Optional) The amount of time (seconds) to wait for the :package: installation to complete before declaring an RPC timeout. This argument was added since most of the time the “package add” RPC takes a significant amount of time. The default RPC timeout is 30 seconds. So this :timeout: value will be used in the context of the SW installation process. Defaults to 30 minutes (30*60=1800) cleanfs_timeout (int) – (Optional) Number of seconds (default 300) to wait for the “request system storage cleanup” to complete. checksum_timeout (int) – (Optional) Number of seconds (default 300) to wait for the calculation of the checksum on the remote Junos device. checksum_algorithm (str) – (Optional) The algorithm to use for computing the checksum. Valid values are: ‘md5’, ‘sha1’, and ‘sha256’. Defaults to ‘md5’. force_copy (bool) – (Optional) When True perform the copy even if :package: is already present at the :remote_path: directory on the remote Junos device. When False (default) if the :package: is already present at the :remote_path:, AND the local checksum matches the remote checksum, then skip the copy to optimize time. all_re (bool) – (Optional) When True (default) perform the software install on all Routing Engines of the Junos device. When False if the only preform the software install on the current Routing Engine. vhmhost (bool) – (Optional) A boolean indicating if this is a software update of the vhmhost. The default is vmhost=False. **kwargs (kwargs) – (Optional) Additional keyword arguments are passed through to the “package add” RPC.

Returns:

True when the installation is successful False otherwise

inventory¶

Returns dictionary of file listing information for current and rollback Junos install packages. This information comes from the /packages directory.

Warning

Experimental method; may not work on all platforms. If you find this not working, please report issue.

classmethod local_checksum(package, algorithm='md5')[source]¶

Computes the checksum value on the local package file.

Parameters:	package (str) – File-path to the package (*.tgz) file on the local server algorithm (str) – The algorithm to use for computing the checksum. Valid values are: ‘md5’, ‘sha1’, and ‘sha256’. Defaults to ‘md5’.
Returns:	checksum (str)
Raises:	IOError – when package file does not exist

classmethod local_md5(package)[source]¶

Computes the MD5 checksum value on the local package file.

Parameters:	package (str) – File-path to the package (*.tgz) file on the local server
Returns:	MD5 checksum (str)
Raises:	IOError – when package file does not exist

classmethod local_sha1(package)[source]¶

Computes the SHA1 checksum value on the local package file.

Parameters:	package (str) – File-path to the package (*.tgz) file on the local server
Returns:	SHA1 checksum (str)
Raises:	IOError – when package file does not exist

classmethod local_sha256(package)[source]¶

Computes the SHA-256 value on the package file.

Parameters:	package (str) – File-path to the package (*.tgz) file on the local server
Returns:	SHA-256 checksum (str)
Raises:	IOError – when package file does not exist

pkgadd(remote_package, vmhost=False, **kvargs)[source]¶

Issue the RPC equivalent of the ‘request system software add’ command or the ‘request vmhost software add’ command on the package. If vhmhost=False, the <request-package-add> RPC is used and the The “no-validate” options is set. If you want to validate the image, do that using the specific validate() method. If vmhost=True, the <request-vmhost-package-add> RPC is used.

If you want to reboot the device, invoke the reboot() method after installing the software rather than passing the reboot=True parameter.

Parameters:	remote_package (str) – The file-path to the install package on the remote (Junos) device. vhmhost (bool) – (Optional) A boolean indicating if this is a software update of the vhmhost. The default is vmhost=False. kvargs (dict) – Any additional parameters to the ‘request’ command can be passed within kvargs, following the RPC syntax methodology (dash-2-underscore,etc.)

Warning

Refer to the restrictions listed in install().

pkgaddISSU(remote_package, vmhost=False, **kvargs)[source]¶

Issue the RPC equivalent of the ‘request system software in-service-upgrade’ command or the ‘request vmhost software in-service-upgrade’ command on the package. If vhmhost=False, the <request-package-in-service-upgrade> RPC is used. If vmhost=True, the <request-vmhost-package-in-service-upgrade> RPC is used.

Parameters:	remote_package (str) – The file-path to the install package on the remote (Junos) device. vhmhost (bool) – (Optional) A boolean indicating if this is a software update of the vhmhost. The default is vmhost=False.

pkgaddNSSU(remote_package, **kvargs)[source]¶

Issue the ‘request system software nonstop-upgrade’ command on the package.

Parameters:	remote_package (str) – The file-path to the install package on the remote (Junos) device.

poweroff(in_min=0)[source]¶

Perform a system shutdown, with optional delay (in minutes) .

If the device is equipped with dual-RE, then both RE will be rebooted. This code also handles EX/QFX VC.

Parameters:	in_min (int) – time (minutes) before rebooting the device.
Returns:	reboot message (string) if command successful
Raises:	RpcError – when command is not successful.

Todo

need to better handle the exception event.

classmethod progress(dev, report)[source]¶

simple progress report function

put(package, remote_path='/var/tmp', progress=None)[source]¶

SCP or FTP ‘put’ the package file from the local server to the remote device.

Parameters:	package (str) – File path to the package file on the local file system remote_path (str) – The directory on the device where the package will be copied to. progress (func) – Callback function to indicate progress. If set to True uses scp._scp_progress() for basic reporting by default. See that class method for details.

reboot(in_min=0, at=None, all_re=True)[source]¶

Perform a system reboot, with optional delay (in minutes) or at a specified date and time.

If the device is equipped with dual-RE, then both RE will be rebooted. This code also handles EX/QFX VC.

Parameters:	in_min (int) – time (minutes) before rebooting the device. at (str) – date and time the reboot should take place. The string must match the junos cli reboot syntax all_re (bool) – In case of dual re or VC setup, function by default will reboot all. If all is False will only reboot connected device
Returns:	reboot message (string) if command successful
Raises:	RpcError – when command is not successful.

Todo

need to better handle the exception event.

remote_checksum(remote_package, timeout=300, algorithm='md5')[source]¶

Computes a checksum of the remote_package file on the remote device.

Parameters:	remote_package (str) – The file-path on the remote Junos device timeout (int) – The amount of time (seconds) before declaring an RPC timeout. The default RPC timeout is generally around 30 seconds. So this :timeout: value will be used in the context of the checksum process. Defaults to 5 minutes (5*60=300) algorithm (str) – The algorithm to use for computing the checksum. Valid values are: ‘md5’, ‘sha1’, and ‘sha256’. Defaults to ‘md5’.
Returns:	The checksum string None when the remote_package is not found.
Raises:	RpcError – RPC errors other than remote_package not found.

rollback()[source]¶

Issues the ‘request’ command to do the rollback and returns the string output of the results.

Returns:	Rollback results (str)

safe_copy(package, remote_path='/var/tmp', progress=None, cleanfs=True, cleanfs_timeout=300, checksum=None, checksum_timeout=300, checksum_algorithm='md5', force_copy=False)[source]¶

Copy the install package safely to the remote device. By default this means to clean the filesystem to make space, perform the secure-copy, and then verify the checksum.

Parameters:

package (str) – file-path to package on local filesystem remote_path (str) – file-path to directory on remote device progress (func) – call-back function for progress updates. If set to True uses sw.progress() for basic reporting by default. cleanfs (bool) – When True (default) perform a “request system storage cleanup” on the device. cleanfs_timeout (int) – Number of seconds (default 300) to wait for the “request system storage cleanup” to complete. checksum (str) – This is the checksum string as computed on the local system. This value will be used to compare the checksum on the remote Junos device. checksum_timeout (int) – Number of seconds (default 300) to wait for the calculation of the checksum on the remote Junos device. checksum_algorithm (str) – The algorithm to use for computing the checksum. Valid values are: ‘md5’, ‘sha1’, and ‘sha256’. Defaults to ‘md5’. force_copy (bool) – When True perform the copy even if the package is already present at the remote_path on the device. When False (default) if the package is already present at the remote_path, and the local checksum matches the remote checksum, then skip the copy to optimize time.

Returns:

True when the copy was successful False otherwise

validate(remote_package, issu=False, nssu=False, **kwargs)[source]¶

Issues the ‘request’ operation to validate the package against the config.

Returns:	True if validation passes. i.e return code (rc) value is 0 False otherwise

jnpr.junos.utils.util¶

Junos PyEZ Utility Base Class

class jnpr.junos.utils.util.Util(dev)[source]¶

Bases: object

Base class for all utility classes

__init__(dev)[source]¶

x.__init__(…) initializes x; see help(type(x)) for signature

dev¶

Returns:	the Device object

rpc¶

Returns:	Device RPC meta object

jnpr.junos.utils.ftp¶

FTP utility

class jnpr.junos.utils.ftp.FTP(junos, **ftpargs)[source]¶

Bases: ftplib.FTP

FTP utility can be used to transfer files to and from device.

__init__(junos, **ftpargs)[source]¶

Parameters:	junos (Device) – Device object ftpargs (kvargs) – any additional args to be passed to ftplib FTP

Supports python context-manager pattern. For example:

from jnpr.junos.utils.ftp import FTP
with FTP(dev) as ftp:
    ftp.put(package, remote_path)

get(remote_file, local_path='/home/docs/checkouts/readthedocs.org/user_builds/junos-pyez/checkouts/2.1.9/docs')[source]¶

This function is used to download file from router to local execution server/shell.

Parameters:	local_path – path in which to receive files locally remote_file – Full path along with filename on the router. If ignored FILE will be copied to “tmp”
Returns:	True if the transfer succeeds, else False

open()[source]¶

put(local_file, remote_path=None)[source]¶

This function is used to upload file to the router from local execution server/shell.

Parameters:	local_file – Full path along with filename which has to be copied to router remote_path – path in which to receive the files on the remote host. If ignored FILE will be copied to “tmp”
Returns:	True if the transfer succeeds, else False