0.2.10-2023.1.2 • Published 8 months ago

@itentialopensource/nso-device-onboarding v0.2.10-2023.1.2

Weekly downloads
32
License
Apache-2.0
Repository
-
Last release
8 months ago

NSO Device Onboarding

Table of Contents

Overview

The NSO Device Onboarding Pre-Built Automation onboards one device or multiple devices into NSO instance. Once the user has provided all of the required parameters and chooses to continue, the workflow will begin to onboard each of the provided devices.

Capabilities

  • This prebuilt allows a user to onboard devices into an NSO instance.
  • Can add a device into the NSO database
  • Perform a fetch on the device SSH keys (if applicable)
  • Execute a sync-from on the device being onboarded
  • If autoApprove flag is enabled then at the end of the workflow, the user will be presented with a comprehensive report that lists the following:
    • Devices that were successfully onboarded
    • Devices that were not added to the NSO database
    • Devices that failed Sync-From
    • Devices that failed to fetch SSH keys (if applicable)

Getting Started

Supported IAP Versions

Itential Pre-Built Automations are built and tested on particular versions of IAP. In addition, Pre-Built Automations that work with devices are often dependent on certain orchestration systems (e.g. NSO and IAG). As such, these Pre-Built Automations will have dependencies on these other systems. This version of the NSO Device Onboarding Pre-Built Automation has been tested with:

  • IAP 2022.1

Known Limitations

NSO Device Onboarding does NOT currently support Juniper or F5 devices. There are plans to support both of these devices in future releases of the artifact.

External Dependencies

Dependency NameDependency Version
NSO^5.7.8

Adapters

No external adapters required to run this Pre-Built Automation.

How to Install

To install the Pre-Built Automation:

  • Verify you are running a supported version of the Itential Automation Platform (IAP) as listed above in the Supported IAP Versions section in order to install the Pre-Built Automation.
  • Import the Pre-Built Automation in Admin Essentials.

Alternatively, you may clone this repository and run npm pack to create a tarball which can then be installed via the offline installer in App-Artifacts. Please consult the documentation for App-Artifacts for further information.

Testing

While Itential tests this Pre-Built Automation and its capabilities, it is often the case the customer environments offer their own unique circumstances. Therefore, it is our recommendation that you deploy this Pre-Built Automation into a development/testing environment in which you can test the Pre-Built Automation.

Using this Pre-Built Automation

Entry Point IAP Component

The primary IAP component to run this Pre-Built Automation is listed below:

IAP Component NameIAP Component Type
IAP NSO Device OnboardingOperations Manager Automation

Inputs

The following is an example input to this Pre-Built Automation:

{
  "formData": {
    "deviceS": [
      {
        "nsoInstance": "nso57",
        "name": "device1",
        "address": "10.10.10.10",
        "port": "22",
        "authgroup": "authgroupName",
        "deviceType": "cli",
        "nedId": "alu-sr-cli-8.32",
        "adminState": "unlocked",
        "protocol": "ssh"
      }
    ],
    "autoApprove": false
  }
}

The following table lists the inputs to the Pre-Built Automation:

NameTypeRequiredDescriptionExample Value
formData.deviceS0.nsoInstancestringyesThe NSO servernso57
formData.deviceS0.namestringyesThe name of the devicedevice1
formData.deviceS0.addressstringyesIP address or host name for the management interface10.10.10.10
formData.deviceS0.portstringyesPort for the management interface22
formData.deviceS0.authgroupstringyesAuthentication credentials for the deviceadmin
formData.deviceS0.deviceTypestringyesManagement protocol for the devicecli
formData.deviceS0.nedIdstringyesThe NED identityalu-sr-cli-8.32
formData.deviceS0.adminStatestringyesThe admin state of the deviceunlocked
formData.deviceS0.protocolstringyesTHE CLI protocolssh
formData.autoApprovebooleanyesif set to true, will not display any manual taskstrue

Outputs

The following is an example output of this Pre-Built Automation:

{
  "devicesAddedSuccessfully": [
    "onboarding-test"
  ],
  "devicesFetchedNotSynced": [],
  "devicesAddednotFetched": [],
  "devicesAddedFailure": []
}

The following table lists the outputs of the Pre-Built Automation:

NameTypeDescriptionExample Value
devicesAddedSuccessfullyarrayList of device names that were successfully onboarded
devicesAddednotFetchedarrayList of device names that are added but failed to fetch SSH keys (if applicable)
devicesAddedFailurearrayList of device names that were not added to the NSO database
devicesFetchedNotSyncedarrayList of device names that are failed Sync-From

Query Output

The following is how to query successful results from the output:

devicesAddedSuccessfully

devicesAddedSuccessfully

The following is how to query unsuccessful results from the output:

devicesAddednotFetched

devicesAddednotFetched

devicesAddedFailure

devicesAddedFailure

devicesFetchedNotSynced

devicesFetchedNotSynced

Error Handling

As mentioned above, NSO Device Onboarding will provide the user with a report that shows devices that were onboarded successfully and any device that failed the onboarding process. If a device fails to be added to the NSO database, fails to fetch SSH keys, or fails sync-from it will be caught and outputted to the user. At each step in the onboarding process a device will be evaluated in terms of erroring, failure, or success. Upon error or failure, the device will be added to a list corresponding to the step in the onboarding process.

Support

Please use your Itential Customer Success account if you need support when using this Pre-Built Automation.

0.2.9-2023.1.1

9 months ago

0.2.8-2022.1.2

8 months ago

0.2.7-2022.1.1

9 months ago

0.2.10-2023.1.2

8 months ago

0.2.9

8 months ago

0.2.8

9 months ago

0.2.8-2023.1.0

10 months ago

0.2.7

10 months ago

0.0.5-2019.3.4

4 years ago

0.0.2-2019.2.5

4 years ago

0.0.5-2019.3.3

4 years ago

0.0.7

4 years ago

0.0.5-2019.3.2

4 years ago

0.0.2-2019.2.4

4 years ago

0.0.6

4 years ago

0.0.5-2019.3.1

4 years ago

0.0.5

4 years ago

0.0.5-2019.3.0

4 years ago

0.0.4

4 years ago

0.0.3-2019.3.2

4 years ago

0.0.3-2019.3.1

4 years ago

0.0.3-2019.3.0

4 years ago

0.0.3

4 years ago

0.0.2-2019.2.3

4 years ago

0.0.2-2019.3.11

4 years ago

0.0.2-2019.2.2

4 years ago

0.0.2-2019.3.10

4 years ago

0.0.2-2019.3.9

4 years ago

0.0.2-2019.2.1

4 years ago

0.0.2-2019.2.0

4 years ago

0.0.2-2019.3.8

4 years ago

0.0.2-2019.3.5

4 years ago

0.0.2-2019.3.6

4 years ago

0.0.2-2019.3.7

4 years ago

0.0.2-2019.3.4

4 years ago

0.0.2-2019.3.3

4 years ago

0.0.2-2019.3.2

4 years ago

0.0.2-2019.3.0

4 years ago

0.0.2-2019.3.1

4 years ago

0.0.2

4 years ago