NVIDIA NEO REST API Guide v2.7.20
NVIDIA NEO REST API Guide v2.7.20

Templates

Description

Using provisioning templates in NEO

Request URL

http://<NEO_SERVER_ADDRESS>/neo/app/provisioning_templates

Main Operations

Get All Templates

Get Template

Description

Retrieves supported Provisioning Templates in NEO

Request URL

GET /neo/app/provisioning_templates

Response

Copy
Copied!
            

[[ { "matchingValidationTemplate": null, "description": "Creates a LAG and defines its mode", "filePath": "/opt/neo/controller/templates/pre-defined/Mellanox/Create-LAG", "validationTemplate": null, "systemProfile": "Ethernet", "parsingScript": null, "systemType": "Mellanox Switch", "owner": "*system*", "title": "Create-LAG", "tags": "Ethernet" }, { "matchingValidationTemplate": null, "description": "Adding port to LAG", "filePath": "/opt/neo/controller/templates/pre-defined/Mellanox/Add-Port-To-LAG", "validationTemplate": null, "systemProfile": "Ethernet", "parsingScript": null, "systemType": "Mellanox Switch", "owner": "*system*", "title": "Add-Port-To-LAG", "tags": "Ethernet" }, ... ]


Description

This interface is used to retrieve the content of a provisioning template

Request URL

GET /neo/app/provisioning_templates/<template_name>

Example

GET /neo/app/provisioning_templates/Set-Email-Notifications

Response

Copy
Copied!
            

{ "matchingValidationTemplate": null, "description": "Sets up an email server and a recipient for email notifications", "filePath": "/opt/neo/controller/templates/pre-defined/Mellanox/Set-Email-Notifica¬tions", "validationTemplate": null, "systemProfile": "", "content": [ "#!desc: Sets up an email server and a recipient for email notifications\n", "#!system_profile:\n", "#!system_type: mlnxos_switch\n", "#!owner: *system*\n", "#<ip_address>|desc:IP address of mail server\n", "#<email_address>|desc:Recipient e-mail address\n", "\n", "email mailhub <ip_address>\n", "email notify recipient <email_address>\n" ], "parsingScript": null, "systemType": "Mellanox Switch", "owner": "*system*", "title": "Set-Email-Notifications", "tags": "" }


General Templates

Available Templates

Description

Arguments

Globals

Locals

Disable-SNMP

Disables SNMP on the switch

Disable-SNMP-V3

Disables SNMP v3

user_name - username to use

Disable-Telnet

Disables the telnet service on the switch

Enable-SNMP

Enables SNMP and defines 'public' community string

community_name - community name to enable

Enable-SNMP-V3

Creates an SNMP v3 user 'admin' with predefined authentication and privacy passwords

private_password - privacy password

authentication_password - Authentication password

user_name - Username to use

Enable-Telnet

Enables the telnet service on the switch

Install-License

Installing Switch license

license_key - License key to install

Remove-SNMP-Host

Removes a trap-receiver

IP_address - IP address of SNMP host to remove

Reset-Counters

Clears all the counters

Set-CLI-Logout

Sets default CLI log-out interval

auto_logout_timeout - Auto-logout timeout value (in minutes)

Set-Email-Notifications

Sets up an email server and a recipient for email notifications

email_address - Recipient e-mail address

IP_address - IP address of mail server

Set-Hostname

Sets hostname of the switch

switch_hostname - Hostname to set

Set-NTP-Server

Sets up an NTP server, sets the time zone and synchronizes the date

NTP_server_IP - NTP server address

time_zone - time zone name

Set-SNMP-V2c-Traps

Adds a trap-receiver for SNMP v2c traps with given community

community_name - community name to use

IP_address - address of trap receiver

Set-SNMP-V3-Traps

Adds a trap-receiver for SNMP v3 traps with username and predefined authentication and privacy passwords

private_password - Privacy password to use

user_name - Username to use

authentication_password - Authentication password to use

IP_address - Address of traps receiver

Show-Running-Config

Shows the running configuration of the switch

Show-SNMP

Shows SNMP settings and status

Show-SNMP-Host

Shows list of trap-receivers

Show-SNMP-User

Shows the list of SNMP users

Show-Power

Displays power supplies and power usage

Show-Fan

Displays fans status and speed.

Show-Health-Report

Displays health report.

Show-Voltage

Displays power supplies voltage level.


Ethernet Templates

Available Templates

Description

Arguments

Globals

Locals

Add-Port-To-LAG

Adding port to LAG

LAG_ID - number of LAG to create or add to

interface_ID - number of interface to add to LAG

Add-VLAN

Adding VLAN to switch

VLAN_ID - number of VLAN to create

VLAN_name - textual name of the VLAN

Check-Lossless-Fabric

Check lossless fabric on switch interfaces

priority - user Priority [0-7]

max_switchport - max switch port (int)

Config-Ethernet-Port

Configuring port as Ethernet

interface_ID - name of port to configure

Config-Splitter

Splits a QSFP port into 4 ports with a related interface

interface_ID - the number of the interface to split

related_interface_ID - the number of the related interface

Config-Splitter-no-Related-If

Splits a QSFP port into 4 ports without a related interface

interface_ID - the number of the interface to split

Config-Un-Split

Un-splits a QSFP port from 4 ports back into a single port

interface_ID - the number of the interface to un-split

Create-LAG

Creates a LAG and defines its mode

LAG_mode - LAG mode (active/on/passive)

interface_range - LAG members in range (Format: 1/1-1/2)

LAG_ID - LAG ID (Format: number)

Delete-VLAN

Removes a VLAN from the switch

VLAN_ID - the number of VLAN to delete

Enable-Flow-Ctrl

Enabling flow control on port

interface_ID - number of interface to enable flow control on

Enable-LACP

Enabling lacp

Enable-LACP-Fast-Rate

Enabling LACP 'fast rate' on port

interface_ID - number of interface to enable LACP fast rate on

Enable-LLDP

Enables LLDP

Enable-OSPF

Enables OSPF on the switch and activates the OSPF router

Enable-PFC

Enabling PFC and setting priority level

priority_level - priority number to enable PFC on

Set-Access-VLAN-LAG

Setting Access VLAN on LAG

LAG_ID - number of LAG to set access VLAN on

VLAN_ID - number of VLAN to set as access VLAN

Set-Access-VLAN-Port

Setting Access VLAN on port

VLAN_ID - VLAN number to set as access VLAN

interface_ID - number of interface to set access VLAN on

Set-LAG-Load-Balance

Setting LAG load balancing algorithm

protocol_list

Set-Port-Speed

Setting port speed

speed - speed value (in Mbps)

interface_ID - number of interface to set speed on

Set-Lossless-Fabric

Set lossless fabric on switch interfaces

priority - priority number to use

max_switchport - number of interfaces on the switch (used as max value with port range)

Remove-Hybrid-Vlan-Port

Delete port from VLAN

VLAN_ID - number of VLAN to remove

interface_ID - Number of interface to remove VLAN from

Set-Hybrid-Vlan-Port

Sets port VLAN mode as 'hybrid' and adds an allowed VLAN to it

VLAN_ID - the VLAN number to add

interface_ID - The number of the port to add VLAN to

Create-MLAG

Configures general MLAG settings and IPL (runs on both switches)

VLAN_ID - VLAN Interface ID for IPL (0-4096)

IPL_IP_address - IP Address of IPL Interface

IPL_IP_mask - subnet mask for IPL interfaces (0-32

IPL_LAG_ID - LAG ID to use with IPL ports

MLAG_VIP - virtual IP address for MLAG

IPL_peer_IP_address - IP Address of peer IPL Interface

MLAG_VIP_mask - subnet mask for MLAG Virtual IP (0-32)

IPL_port_range - port range to use for IPL (example 1/1-1/2)

MLAG_system_MAC - virtual system MAC

Disable-MAC-Learning

Disable MAC learning on given interfaces

interface_range - interfaces to disable

Disable-Ports

Disabling Ethernet ports

interface_range - interfaces to shutdown

Disable-Protocol-BGP

Deletes all BGP configuration and hides BGP related commands.

Disable-Protocol-Dot1X

Disables 802.1x EAPOL protocol.

Disable-Protocol-Open-Flow

Disables protocol and hides the OpenFlow commands

Disable-Protocol-PIM

Hides all PIM commands and deletes all PIM configurations.

Disable-Protocol-SFlow

Deletes sFlow configuration and hides the sFlow commands

Disable-Protocol-VRRP

Deletes all the VRRP configuration and hides VRRP related commands

Enable-DCB-Priority-Flow-Control

Enables PFC per interfaces.

interface_range - Interfaces to set for priority-flow-control

Enable-MAC-Learning

Enable MAC learning on given interfaces

interface_range - Interfaces to enable

Enable-Ports

Enabling Ethernet ports

interface_range - Interfaces to enable

Enable-Protocol-BGP

Enables BGP feature, and exposes BGP related commands.

Enable-Protocol-Dot1X

Enables 802.1x EAPOL protocol

Enable-Protocol-Open-Flow

Enables protocol and exposes the OpenFlow commands

Enable-Protocol-PIM

Enables protocol independent multicast (PIM).

Enable-Protocol-SFlow

Enables SFlow and exposes SFlow related commands

Enable-Protocol-VRRP

Enables VRRP globally and exposes VRRP related commands

Set-MTU

Setting MTU on interfaces

interface_range - interfaces to set MTU

MTU_size - MTU size (1500-9216)

Show-Access-Lists

Displays the access-lists

Show-DCB-ETS

Displays ETS configuration and operational data.

Show-DCB-Priority-Flow-Control

Displays DCB priority flow control configuration and status.

Show-MLAG

Displays MLAG configuration and status.

Show-MLAG-VIP

Displays MLAG VIP configuration and status.

Show-Protocols

Displays all protocols enabled in the system.

Show-VLAN

Displays the VLAN table.

Show-System-MAC

Displays system MAC address.

Add-VLAN-To-OSPF-Area

Sets the OSPF area of the VLAN interface, and creates the area in case it does not exist.

VLAN_ID - the VLAN ID to set the OSPF area on

area_ID - the area ID to be added

Config-MAGP-Router

Configures MAGP router per VLAN (runs on both switches, L3 only).

VLAN_ID - the VLAN ID to configure MAGP on

router_IP - router IP address

router_IP_mask - the subnet mask of the router IP

router_VIP - the virtual router IP address

router_VMAC - the virtual system MAC

Config-MLAG-Ports

Configures MLAG ports (runs on both switches, configured per server port).

MLAG_ID - the MLAG ID to configure

interface_ID - The interface number to add MLAG to

VLAN_ID - VLAN ID of MLAG port channel

Disable-Protocol-MAGP

Deletes all the MAGP configuration and hides MAGP commands.

Enable-Protocol-MAGP

Enables MAGP globally and exposes MAGP commands.

Show-Cable-Info

Displays cable information of a given interface.

interface_ID - the interface number to show cable info on


InfiniBand Templates

Available Templates

Description

Arguments

Globals

Locals

Disable-SM

Disables Subnet Manager

Enable-SM

Enables Subnet Manager


© Copyright 2023, NVIDIA. Last updated on Nov 16, 2023.