File manager - Edit - /opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/netbox.cpython-310.pyc
Back
o ;j݀ � @ s� d Z ddlZddlZddlmZ zddlZdZW n ey# dZY nw e�e �Z dZ ddd �Z d d � Z d d � ZdVdd�Zdd� Zdd� Zdd� Zdd� ZdWdd�Zdd� Zd d � ZdXd d �Zd d!� Zd"d#� Zd$d%� Zd&d'� Zd(d)� Z d*d+� Z d,d-� Z . . .dYd/d0�Z d1d2� Z d3d4� Z!dXd5d6�Z"dXd7d8�Z#dXd9d:�Z$ dZd;d<�Z%d=d>� Z&d?d@� Z'dAdB� Z(dCdD� Z)dXdEdF�Z*d[dGdH�Z+dIdJ� Z,dXdKdL�Z-dXdMdN�Z.dOdP� Z/dXdQdR�Z0 Sd\dTdU�Z1dS )]a� NetBox ====== Module to query NetBox :codeauthor: Zach Moody <zmoody@do.co> :maturity: new :depends: pynetbox The following config should be in the minion config file. In order to work with ``secrets`` you should provide a token and path to your private key file: .. code-block:: yaml netbox: url: <NETBOX_URL> token: <NETBOX_USERNAME_API_TOKEN (OPTIONAL)> keyfile: </PATH/TO/NETBOX/KEY (OPTIONAL)> .. versionadded:: 2018.3.0 � N)�CommandExecutionErrorTF)Zsecrets�filter�get)�filter_�get_c C s t sdS dS )z% pynetbox must be installed. )FzPThe netbox execution module cannot be loaded: pynetbox library is not installed.T)� HAS_PYNETBOX� r r �G/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/netbox.py� __virtual__, s r c C s t d d�} | s td��| S )Nz config.getZnetboxz8NetBox execution module configuration could not be found)Z__salt__r )�configr r r �_config: s �r c C sB i }t � �d�|d< | rt � �d�|d< tjt � �d�fi |��S )N�token�keyfileZprivate_key_file�url)r r �pynetboxZapi)� auth_requiredZ pynb_kwargsr r r �_nb_objC s r c C s: d| � � v r | d= | �� D ] \}}t|t�rt|� q | S )Nr )�keys�items� isinstance�dict�_strip_url_field)Z input_dict�k�vr r r r K s �r c C s | rt | �S i S �N)r )�iterabler r r �_dictT s r c C sl t dd�}ztt|| �|�jdi |��W S tjy5 } zt�d|jjj |j |j� W Y d}~dS d}~ww )z POST a payload T�r � %s, %s, %sNFr ) r �getattr�creater � RequestError�log�error�req�request�headers� request_body)�app�endpoint�payload�nb�er r r �_add[ s ��r- c C s$ t �dd| ��� �� } t �dd| �S )z�' Slugify given value. Credit to Djangoproject https://docs.djangoproject.com/en/2.0/_modules/django/utils/text/#slugify z[^\w\s-]� z[-\s]+�-)�re�sub�strip�lower)�valuer r r �slugifyg s r5 c K sZ t |d�}|rtt|| �|��|�}|S td di |��}tt|| �|�jdi |��}|S )z� Helper function to do a GET request to Netbox. Returns the actual pynetbox object, which allows manipulation from other functions. r �args.clean_kwargsNr )r r r � __utils__)r( r) �idr �kwargsr+ �itemr r r �_getp s � r; c C s" | � d�}t|�dkr |S | dfS )N�.� �0)�split�len)�if_nameZ if_name_splitr r r � _if_name_unit~ s rB c K sZ g }t | tv r dndd�}tt|| �|�jdi td di |����}|r+dd� |D �}|S ) aH Get a list of items from NetBox. app String of netbox app, e.g., ``dcim``, ``circuits``, ``ipam`` endpoint String of app endpoint, e.g., ``sites``, ``regions``, ``devices`` kwargs Optional arguments that can be used to filter. All filter keywords are available in Netbox, which can be found by surfing to the corresponding API endpoint, and clicking Filters. e.g., ``role=router`` Returns a list of dictionaries .. code-block:: bash salt myminion netbox.filter dcim devices status=1 role=router TFr r6 c S s g | ]}t t|���qS r )r r )�.0�ir r r � <listcomp>� s zfilter_.<locals>.<listcomp>Nr )r �AUTH_ENDPOINTSr r r7 )r( r) r9 �retr+ Znb_queryr r r r � s �r c K s( t t| |f|| tv r dndd�|���S )a Get a single item from NetBox. app String of netbox app, e.g., ``dcim``, ``circuits``, ``ipam`` endpoint String of app endpoint, e.g., ``sites``, ``regions``, ``devices`` Returns a single dictionary To get an item based on ID. .. code-block:: bash salt myminion netbox.get dcim devices id=123 Or using named arguments that correspond with accepted filters on the NetBox endpoint. .. code-block:: bash salt myminion netbox.get dcim devices name=my-router TF)r8 r )r r; rF )r( r) r8 r9 r r r r � s ����r c C sD t dd| d�}|r dS | t| �d�}tdd|�}|r dd|iiS dS )z� .. versionadded:: 2019.2.0 Create a device manufacturer. name The name of the manufacturer, e.g., ``Juniper`` CLI Example: .. code-block:: bash salt myminion netbox.create_manufacturer Juniper �dcim� manufacturers��nameF�rK �slug�r r5 r- )rK �nb_manr* Zmanr r r �create_manufacturer� � rP c C s� t dd| d�}|r dS t dd|d�}d}|st|�}| |d t| �d �}tdd|�}dd|ii}|r;|d �|d � |r?|S dS ) am .. versionadded:: 2019.2.0 Create a device type. If the manufacturer doesn't exist, create a new manufacturer. model String of device model, e.g., ``MX480`` manufacturer String of device manufacturer, e.g., ``Juniper`` CLI Example: .. code-block:: bash salt myminion netbox.create_device_type MX480 Juniper rH � device-types��modelFrI rJ Nr8 )rT � manufacturerrM )r rP r5 r- �update)rT rU �nb_typerO Znew_manr* �typZret_dictr r r �create_device_type� s rY c C sF t dd| d�}|r dS | t| �|d�}tdd|�} | r!dd|iiS dS )z� .. versionadded:: 2019.2.0 Create a device role role String of device role, e.g., ``router`` CLI Example: .. code-block:: bash salt myminion netbox.create_device_role router rH � device-rolesrJ F)rK rM �colorrN )�roler[ �nb_roler* r r r �create_device_role s r^ c C sH t ddt| �d�}|r dS | t| �d�}tdd|�}|r"dd|iiS dS )z� .. versionadded:: 2019.2.0 Create a new device platform platform String of device platform, e.g., ``junos`` CLI Example: .. code-block:: bash salt myminion netbox.create_platform junos rH Z platforms�rM FrL rN )�platformZ nb_platformr* �platr r r �create_platform s rb c C sD t dd| d�}|r dS | t| �d�}tdd|�} | r dd|iiS dS )z� .. versionadded:: 2019.2.0 Create a new device site site String of device site, e.g., ``BRU`` CLI Example: .. code-block:: bash salt myminion netbox.create_site BRU rH �sitesrJ FrL rN )�site�nb_siter* r r r � create_site: rQ rf c C s� z+t dd|d�}|s W dS t dd|d�}|sW dS t dd|d�}|s%W dS dd d �}W n! tjyL } zt�d | jjj| j| j� W Y d } ~ dS d } ~ ww | | t | �|d |d |d d�} t dd| �} | rldd| iiS dS )aU .. versionadded:: 2019.2.0 Create a new device with a name, role, model, manufacturer and site. All these components need to be already in Netbox. name The name of the device, e.g., ``edge_router`` role String of device role, e.g., ``router`` model String of device model, e.g., ``MX480`` manufacturer String of device manufacturer, e.g., ``Juniper`` site String of device site, e.g., ``BRU`` CLI Example: .. code-block:: bash salt myminion netbox.create_device edge_router router MX480 Juniper BRU rH rZ rJ FrR rS rc ZActive� )Zlabelr4 r Nr8 )rK Z display_namerM Z device_typeZ device_rolerd �devices) r r r! r" r# r$ r% r& r' r5 r- ) rK r\ rT rU rd r] rW re �statusr, r* Znew_devr r r � create_deviceU s6 ��� rj c K s� t d d i |��}tddd| d�}|�� D ] \}}t|||� qz |�� dd|iiW S tjyL } zt�d|j j j |j |j� W Y d}~dS d}~ww ) ad .. versionadded:: 2019.2.0 Add attributes to an existing device, identified by name. name The name of the device, e.g., ``edge_router`` kwargs Arguments to change in device, e.g., ``serial=JN2932930`` CLI Example: .. code-block:: bash salt myminion netbox.update_device edge_router serial=JN2932920 r6 rH rh T)r rK r NFr ) r7 r; r �setattr�saver r! r" r# r$ r% r& r' )rK r9 � nb_devicer r r, r r r � update_device� s ��rn r. c C s� t dd| d�}|s dS |r!t dd|d�}|s!t|� t dd|d�}|d ||||dd�}|r4|d |d < tdd |�} | rBdd |iiS | S ) a� .. versionadded:: 2019.2.0 Add an inventory item to an existing device. device_name The name of the device, e.g., ``edge_router``. item_name String of inventory item name, e.g., ``Transceiver``. manufacturer_name String of inventory item manufacturer, e.g., ``Fiberstore``. serial String of inventory item serial, e.g., ``FS1238931``. part_id String of inventory item part id, e.g., ``740-01234``. description String of inventory item description, e.g., ``SFP+-10G-LR``. CLI Example: .. code-block:: bash salt myminion netbox.create_inventory_item edge_router Transceiver part_id=740-01234 rH rh rJ FrI r8 N)�devicerK � description�serial�part_id�parentrU �inventory-items)r rP r- ) � device_nameZ item_nameZmanufacturer_namerq rr rp rm rO r* Zdoner r r �create_inventory_item� s* $� rv c C s( t ddd| d�}|�� ddd| iiiS )a .. versionadded:: 2019.2.0 Remove an item from a devices inventory. Identified by the netbox id item_id Integer of item to be deleted CLI Example: .. code-block:: bash salt myminion netbox.delete_inventory_item 1354 rH rt T�r r8 �DELETE�r; �delete)Zitem_idZnb_inventory_itemr r r �delete_inventory_item� s r{ c C s2 | |d�}t dd|�}|rdd|d |iiiS |S )a, .. versionadded:: 2019.2.0 Create an interface connection between 2 interfaces interface_a Interface id for Side A interface_b Interface id for Side B CLI Example: .. code-block:: bash salt myminion netbox.create_interface_connection 123 456 )� interface_a� interface_brH zinterface-connectionsr8 )r- )r| r} r* rG r r r �create_interface_connection� s r~ c K s0 | st d } tdd| d�}tdd|d i|��S ) am .. versionadded:: 2019.2.0 Returns interfaces for a specific device using arbitrary netbox filters device_name The name of the device, e.g., ``edge_router`` kwargs Optional arguments to be used for filtering CLI Example: .. code-block:: bash salt myminion netbox.get_interfaces edge_router name="et-0/0/5" r8 rH rh rJ � interfaces� device_idN)rH r �Z__opts__r r �ru r9 Z netbox_devicer r r �get_interfaces s r� c C s2 i }t | d�}t| d�}|D ]�}t|d �\}}||vr'd|idi id�||< |dkrx|d || d d< |d rg||d krLt|d �|| d d< nd d|ddt|d �iiiii}td || |�||< |d rwt|d �|| d d < qdt|�|d d �i|| d d |< |d r�t|d �|| d d | d d< q|D ]n}|d �d�\} } |d d }t|�\}}d�|d �} ||| d d vr�dt|�dd �i|| d d |< | || d d | vr�dd i ii|| d d | | < d| t| �d�i|| d d | | d d | < q�dd|iiS )a} .. versionadded:: 2019.2.0 Return a dictionary structured as standardised in the `openconfig-interfaces <http://ops.openconfig.net/branches/models/master/openconfig-interfaces.html>`_ YANG model, containing physical and configuration data available in Netbox, e.g., IP addresses, MTU, enabled / disabled, etc. device_name: ``None`` The name of the device to query the interface data for. If not provided, will use the Minion ID. CLI Example: .. code-block:: bash salt '*' netbox.openconfig_interfaces salt '*' netbox.openconfig_interfaces device_name=cr1.thn.lon �ru rK Z subinterface)r � subinterfacesr> �enabledr rp r� zdictupdate.updateZmtu)�indexr� �address�/� interfacezipv{}�familyT� addresses)�ip� prefix_lengthr )r� �get_ipaddressesrB �strr7 �intr? �format) ru Zoc_ifr Z ipaddressesr� rA �if_unitZ subif_descr� ipaddressr� r� Zipvkeyr r r �openconfig_interfaces, st � � ����� ��� ��� ����� r� c C s� i }t | d�}|D ]0}|d sq t|d �\}}|d d }||vr/|ddd�di id�||< i || d d |< q d d d |iiiS ) a� .. versionadded:: 2019.2.0 Return a dictionary structured as standardised in the `openconfig-lacp <http://ops.openconfig.net/branches/models/master/openconfig-lacp.html>`_ YANG model, with configuration data for Link Aggregation Control Protocol (LACP) for aggregate interfaces. .. note:: The ``interval`` and ``lacp_mode`` keys have the values set as ``SLOW`` and ``ACTIVE`` respectively, as this data is not currently available in Netbox, therefore defaulting to the values defined in the standard. See `interval <http://ops.openconfig.net/branches/models/master/docs/openconfig-lacp.html#lacp-interfaces-interface-config-interval>`_ and `lacp-mode <http://ops.openconfig.net/branches/models/master/docs/openconfig-lacp.html#lacp-interfaces-interface-config-lacp-mode>`_ for further details. device_name: ``None`` The name of the device to query the LACP information for. If not provided, will use the Minion ID. CLI Example: .. code-block:: bash salt '*' netbox.openconfig_lacp salt '*' netbox.openconfig_lacp device_name=cr1.thn.lon r� �lagrK ZSLOWZACTIVE)rK �intervalZ lacp_mode�member)r �membersr� Zlacpr r� )r� rB )ru Zoc_lacpr r� rA r� Z parent_ifr r r �openconfig_lacp s � �r� c C s� t dd| d�}|s dS |rt dd|d |d�} | sdS |s d}|s#d }|d |||d d �} |d ur5|| d < |r;d| d < |rC| d | d< |rI|| d< t dd|d |d�} | s[tdd| �} | rgdd| d | iiiS | S )a� .. versionadded:: 2019.2.0 Attach an interface to a device. If not all arguments are provided, they will default to Netbox defaults. device_name The name of the device, e.g., ``edge_router`` interface_name The name of the interface, e.g., ``TenGigE0/0/0/0`` mac_address String of mac address, e.g., ``50:87:89:73:92:C8`` description String of interface description, e.g., ``NTT`` enabled String of boolean interface status, e.g., ``True`` lag: Boolean of interface lag status, e.g., ``True`` lag_parent String of interface lag parent name, e.g., ``ae13`` form_factor Integer of form factor id, obtained through _choices API endpoint, e.g., ``200`` CLI Example: .. code-block:: bash salt myminion netbox.create_interface edge_router ae13 description="Core uplink" rH rh rJ Fr r8 �r� rK r. �falsei� )ro rK rp r� � form_factorNr� �� r� � mac_address�r r- ) ru �interface_namer� rp r� r� Z lag_parentr� rm Z lag_interfacer* � nb_interfacer r r �create_interface� sF ' �� � r� c K s� t dd| d�}tddd|d |d�}|sdS |sdS td d i |���� D ] \}}t|||� q%z|�� dd|jt|�iiiW S tj ya } zt � d |j j j|j|j � W Y d }~dS d }~ww ) a� .. versionadded:: 2019.2.0 Update an existing interface with new attributes. device_name The name of the device, e.g., ``edge_router`` interface_name The name of the interface, e.g., ``ae13`` kwargs Arguments to change in interface, e.g., ``mac_address=50:87:69:53:32:D0`` CLI Example: .. code-block:: bash salt myminion netbox.update_interface edge_router ae13 mac_address=50:87:69:53:32:D0 rH rh rJ r Tr8 �r r� rK Fr6 r Nr )r r; r7 r rk rl r8 r r r! r" r# r$ r% r& r' )ru r� r9 rm r� r r r, r r r �update_interface� s, � ��r� c C sL t dd| d�}tddd|d |d�}|r$|�� ddd|j|jiiiiS d S ) aF .. versionadded:: 2019.2.0 Delete an interface from a device. device_name The name of the device, e.g., ``edge_router``. interface_name The name of the interface, e.g., ``ae13`` CLI Example: .. code-block:: bash salt myminion netbox.delete_interface edge_router ae13 rH rh rJ r Tr8 r� rx F)r r; rz r8 rK )ru r� rm r� r r r �delete_interface) s ��r� c C s t | |dd�S )aG .. versionadded:: 2019.2.0 Update an interface to be a LAG. device_name The name of the device, e.g., ``edge_router``. interface_name The name of the interface, e.g., ``ae13``. CLI Example: .. code-block:: bash salt myminion netbox.make_interface_lag edge_router ae13 r� )r� )r� )ru r� r r r �make_interface_lagK s r� c C s@ t dd| d�}t dd|d |d�}|r |r t| ||d d�S dS ) a� .. versionadded:: 2019.2.0 Set an interface as part of a LAG. device_name The name of the device, e.g., ``edge_router``. interface_name The name of the interface to be attached to LAG, e.g., ``xe-1/0/2``. parent_name The name of the LAG interface, e.g., ``ae13``. CLI Example: .. code-block:: bash salt myminion netbox.make_interface_child xe-1/0/2 ae13 rH rh rJ r r8 r� )r� F)r r� )ru r� � parent_namerm Z nb_parentr r r �make_interface_child` s r� c K s0 | st d } tdd| d�}td d|d i|��S ) ak .. versionadded:: 2019.2.0 Filters for an IP address using specified filters device_name The name of the device to check for the IP address kwargs Optional arguments that can be used to filter, e.g., ``family=4`` CLI Example: .. code-block:: bash salt myminion netbox.get_ipaddresses device_name family=4 r8 rH rh rJ �ipam� ip-addressesr� N)r� r� r� r� r r r r� } s r� c C s� d}|| d�}|r>|r>t dd|d�}|sdS t dd|d |d �}|s$dS t d d | |d |d �}|r8t�|� dS |d |d < td d |�}|rLd d |iiS |S )a .. versionadded:: 2019.2.0 Add an IP address, and optionally attach it to an interface. ip_address The IP address and CIDR, e.g., ``192.168.1.1/24`` family Integer of IP family, e.g., ``4`` device The name of the device to attach IP to, e.g., ``edge_router`` interface The name of the interface to attach IP to, e.g., ``ae13`` CLI Example: .. code-block:: bash salt myminion netbox.create_ipaddress 192.168.1.1/24 4 device=edge_router interface=ae13 N)r� r� rH rh rJ Fr r8 r� r� r� )�qZ interface_idr� r� )r r" r# r- ) � ip_addressr� ro r� Znb_addrr* rm r� Zipaddrr r r �create_ipaddress� s4 �� r� c C s0 t ddd| d�}|r|�� ddd| iiiS dS )a. .. versionadded:: 2019.2.0 Delete an IP address. IP addresses in Netbox are a combination of address and the interface it is assigned to. id The Netbox id for the IP address. CLI Example: .. code-block:: bash salt myminion netbox.delete_ipaddress 9002 r� r� Trw rx z ip-addressFry )Z ipaddr_idZ nb_ipaddrr r r �delete_ipaddress� s r� c C s� t dd| d�}i }|r$|d |krdS t�d| |� td| � d|� ���| t| �d �}|r1||d< tdd|�}|rCdd|d |iiiS |S ) a .. versionadded:: 2019.2.0 Create a new Netbox circuit provider name The name of the circuit provider asn The ASN of the circuit provider CLI Example: .. code-block:: bash salt myminion netbox.create_circuit_provider Telia 1299 �circuits� providersrJ �asnFz-Duplicate provider with different ASN: %s: %sz'Duplicate provider with different ASN: z: rL r8 )r r" r# r r5 r- )rK r� �nb_circuit_providerr* Zcircuit_providerr r r �create_circuit_provider� s � r� c C s( |r t dd|d�}|S t dd| d�}|S )a1 .. versionadded:: 2019.2.0 Get a circuit provider with a given name and optional ASN. name The name of the circuit provider asn The ASN of the circuit provider CLI Example: .. code-block:: bash salt myminion netbox.get_circuit_provider Telia 1299 r� r� )r� rJ )r )rK r� r� r r r �get_circuit_provider s �r� c C sP t ddt| �d�}|r dS | t| �d�}tdd|�}|r&dd|d |iiiS |S )z� .. versionadded:: 2019.2.0 Create a new Netbox circuit type. name The name of the circuit type CLI Example: .. code-block:: bash salt myminion netbox.create_circuit_type Transit r� � circuit-typesr_ FrL r8 rN )rK �nb_circuit_typer* � circuit_typer r r �create_circuit_type s r� c C s� t dd|�}t ddt|�d�}|rB|rB| |d |d d�}|r#||d< t dd| d�}|r.d S tdd|�}|r@dd|d |iiiS |S d S ) a� .. versionadded:: 2019.2.0 Create a new Netbox circuit name Name of the circuit provider_id The netbox id of the circuit provider circuit_type The name of the circuit type asn The ASN of the circuit provider description The description of the circuit CLI Example: .. code-block:: bash salt myminion netbox.create_circuit NEW_CIRCUIT_01 Telia Transit 1299 "New Telia circuit" r� r� r� r_ r8 )�cidZprovider�typerp �r� FrN ) rK Z provider_idr� rp r� r� r* � nb_circuit�circuitr r r �create_circuit9 s" � r� �Ac C s� t dd|d�}t dd|d |d�}t dd| d�}|rS|rUt dd |d d �} | r)d S |d |d |d d ||d�} |r?|| d< tdd | �} | rQdd | d | iiiS | S dS dS )a? .. versionadded:: 2019.2.0 Terminate a circuit on an interface circuit The name of the circuit interface The name of the interface to terminate on device The name of the device the interface belongs to speed The speed of the circuit, in Kbps xconnect_id The cross-connect identifier term_side The side of the circuit termination CLI Example: .. code-block:: bash salt myminion netbox.create_circuit_termination NEW_CIRCUIT_01 xe-0/0/1 myminion 10000 xconnect_id=XCON01 rH rh rJ r r8 r� r� r� zcircuit-terminationsr� )r� Frd )r� r� rd Z port_speed� term_side� xconnect_idNr� ) r� r� ro Zspeedr� r� rm r� r� Znb_terminationr* Zcircuit_terminationr r r �create_circuit_terminationg s. � ���r� )F)NFr )Nr. r. r. )NNNNNN)NN)Nr� )2�__doc__�loggingr0 Zsalt.exceptionsr r r � ImportError� getLogger�__name__r" rF Z__func_alias__r r r r r r- r5 r; rB r r rP rY r^ rb rf rj rn rv r{ r~ r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r r r �<module> sz � ##8 �= S3 �P*" 3 ' /�
| ver. 1.4 |
Github
|
.
| PHP 8.2.30 | Generation time: 0 |
proxy
|
phpinfo
|
Settings