Viewing docs for Cisco NX-OS v0.0.2
published on Friday, Sep 29, 2023 by lbrlabs
published on Friday, Sep 29, 2023 by lbrlabs
Cisco NX OS Resource Provider: Installation & Configuration
I want to use the Pulumi Cisco NX-OS package (nxos) in my project.
## Provider details
- Package: nxos
- Version: v0.0.2
- Publisher: lbrlabs
- Source: pulumi
- Repository: https://github.com/lbrlabs/pulumi-nxos
## Documentation
The Pulumi Cloud Registry API serves canonical, up-to-date docs for this package — including private packages and every published version. Send the "Accept: text/markdown" header for clean readable content, or "application/json" for structured data.
Start at the navigation tree, which cross-links to the readme, installation guide, and per-resource docs URL template:
- https://api.pulumi.com/api/registry/packages/pulumi/lbrlabs/nxos/versions/latest/nav
Returns a summary by default. The full tree can be hundreds of kB for large providers, so prefer targeted search: append "?q=<query>&depth=full" to filter by resource/function title or token (for example "?q=bucket&depth=full"). Only request the full nav without a query if you actually need to enumerate every resource.
Other endpoints:
- Overview and getting started: https://api.pulumi.com/api/registry/packages/pulumi/lbrlabs/nxos/versions/latest/readme
- Installation and configuration: https://api.pulumi.com/api/registry/packages/pulumi/lbrlabs/nxos/versions/latest/installation
- Per-resource/function docs: https://api.pulumi.com/api/registry/packages/pulumi/lbrlabs/nxos/versions/latest/docs/{token}?lang={lang}
Replace {token} with the percent-encoded token from the nav response (for example aws:s3/bucket:Bucket).
Replace {lang} with typescript, python, go, csharp, java, or yaml.
Fetch the installation endpoint above for the correct setup steps — install instructions vary between native providers, bridged Terraform providers, and component packages.
Help me get started using this provider. Show me a complete Pulumi program that provisions a common resource, including all necessary configuration and imports.
Viewing docs for Cisco NX-OS v0.0.2
published on Friday, Sep 29, 2023 by lbrlabs
published on Friday, Sep 29, 2023 by lbrlabs
Installation
The Pulumi NX OS provider is available as a package in all Pulumi languages:
- JavaScript/TypeScript:
@lbrlabs/pulumi-nxos - Python:
lbrlabs_pulumi_nxos - Go:
github.com/lbrlabs/pulumi-nxos/sdk/go/nxos - .NET:
Lbrlabs.PulumiPackage.nxos
Provider Binary
The Grafana provider binary is a third party binary. It can be installed using the pulumi plugin command.
pulumi plugin install resource nxos <version> --server github://api.github.com/lbrlabs
Replace the version string with your desired version.
Setup
To provision resources with the Pulumi Cisco nxos XE provider, you need to have credentials.
Set environment variables
Once you have provisioned these credentials, you can set environment variables to provision resources in Grafana:
$ export NXOS_PASSWORD=<PASSWORD>
$ export NXOS_URL=<URL>
$ export NXOS_USERNAME=<USERNAME>
$ export NXOS_PASSWORD=<PASSWORD>
$ export NXOS_URL=<URL>
$ export NXOS_USERNAME=<USERNAME>
> $env:nxos_PASSWORD = "<PASSWORD>"
> $env:nxos_URL = "<URL>"
> $env:nxos_USERNAME = "<USERNAME>"
Configuration Options
Use pulumi config set nxos:<option> or pass options to the constructor of new nxos.Provider.
Viewing docs for Cisco NX-OS v0.0.2
published on Friday, Sep 29, 2023 by lbrlabs
published on Friday, Sep 29, 2023 by lbrlabs