Skip to main content

A library for managing Cisco devices through NX-API using XML or jsonrpc.

Project description

nxapi-plumbing

A low-level library for managing Cisco devices through NX-API using JSON-RPC and XML.

Examples:

Creating device object using JSON-RPC.

from nxapi_plumbing import Device

device = Device(
    api_format="jsonrpc",
    host="device.domain.com",
    username="admin",
    password="password",
    transport="https",
    port=8443,
)

JSON-RPC single command that returns structured data.

output = device.show("show hostname")
print(output)

Output would be the response from the command

{'hostname': 'nxos.domain.com'}

JSON-RPC list of commands

output = device.show_list(["show hostname", "show ntp status"])
pprint(output)

Output would be a list of responses (list of dictionaries)

[
    {
        "command": "show hostname",
        "result": {
            "hostname": "nxos.domain.com"
        }
    },
    {
        "command": "show ntp status",
        "result": {
            "distribution": "Distribution : Disabled",
            "operational_state": "Last operational state: No session"
        }
    }
]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nxapi_plumbing-0.5.2.tar.gz (11.5 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page