canu generate
Canu generate commands.
canu generate [OPTIONS] COMMAND [ARGS]...
network
Canu generate network commands.
canu generate network [OPTIONS] COMMAND [ARGS]...
config
Generate the config of all switches (Aruba, Dell, or Mellanox) on the network using the SHCD.
In order to generate network switch config, a valid SHCD must be passed in and system variables must be read in from either an SLS output file or the SLS API.
CSI Input
- In order to parse network data using SLS, pass in the file containing SLS JSON data (normally sls_file.json) using the ‘–sls-file’ flag
- If used, CSI-generated sls_input_file.json file is generally stored in one of two places depending on how far the system is in the install process.
- Early in the install process, when running off of the LiveCD the sls_input_file.json file is normally found in the the directory ‘/var/www/ephemeral/prep/SYSTEMNAME/’
- Later in the install process, the sls_file.json file is generally in ‘/mnt/pitdata/prep/SYSTEMNAME/’
SLS API Input
- To parse the Shasta SLS API for IP addresses, ensure that you have a valid token.
- The token file can either be passed in with the ‘–auth-token TOKEN_FILE’ flag, or it can be automatically read if the environmental variable ‘SLS_TOKEN’ is set.
- The SLS address is default set to ‘api-gw-service-nmn.local’.
- if you are operating on a system with a different address, you can set it with the ‘–sls-address SLS_ADDRESS’ flag.
SHCD Input
- Use the ‘–tabs’ flag to select which tabs on the spreadsheet will be included.
- The ‘–corners’ flag is used to input the upper left and lower right corners of the table on each tab of the worksheet. If the corners are not specified, you will be prompted to enter them for each tab.
- The table should contain the 11 headers: Source, Rack, Location, Slot, (Blank), Port, Destination, Rack, Location, (Blank), Port.
Use the ‘–folder FOLDERNAME’ flag to output all the switch configs to a folder.
noqa: D301, B950
Args:
: ctx: CANU context settings
csm: CSM version
architecture: CSM architecture
ccj: Paddle CCJ file
shcd: SHCD file
tabs: The tabs on the SHCD file to check, e.g. 10G_25G_40G_100G,NMN,HMN.
corners: The corners on each tab, comma separated e.g. ‘J37,U227,J15,T47,J20,U167’.
sls_file: Directory containing the CSI json file
auth_token: Token for SLS authentication
sls_address: The address of SLS
folder: Folder to store config files
preserve: Folder where switch running configs exist. This folder should be populated from the “canu backup network” command.
custom_config: yaml file containing customized switch configurations which is merged with the generated config.
edge: Vendor of the edge router
reorder: Filters generated configurations through hier_config generate a more natural running-configuration order.
bgp_control_plane: Network used for BGP control plane
vrf: Named VRF used for CSM networks
bond_app_nodes: Generates bonded configuration for application nodes connected the NMN.
log_
: Level of logging.
canu generate network config [OPTIONS]
Options
--csm
Required CSM network version
- Options: 1.0 | 1.2 | 1.3 | 1.4 | 1.5 | 1.6
-a, --architecture
CSM architecture
- Options: Full | TDS | V1
--ccj
Paddle CCJ file
--shcd
SHCD file
--tabs
The tabs on the SHCD file to check, e.g. 10G_25G_40G_100G,NMN,HMN.
--corners
The corners on each tab, comma separated e.g. ‘J37,U227,J15,T47,J20,U167’.
--sls-file
File containing system SLS JSON data.
--auth-token
Token for SLS authentication
--sls-address
- Default:
'api-gw-service-nmn.local'
--folder
Required Folder to store config files
--custom-config
Custom switch configuration
--edge
Required Vendor of Edge router
- Options: Aruba | Arista
--preserve
Path to current running configs.
--reorder
reorder config to heir config order
--bgp-control-plane
Network used for BGP control plane
- Options: CMN | CHN
--vrf
Named VRF used for CSM networks
--bond-app-nodes
Bond application nodes on the NMN network
--log
Level of logging.
- Options: DEBUG | INFO | WARNING | ERROR
Environment variables
SLS_TOKEN
Provide a default for
--auth-token
switch
Canu generate switch commands.
canu generate switch [OPTIONS] COMMAND [ARGS]...
config
Generate switch config using the SHCD.
In order to generate switch config, a valid SHCD must be passed in and system variables must be read in from either an SLS output file or the SLS API.
CSI Input
- In order to parse network data using SLS, pass in the file containing SLS JSON data (normally sls_file.json) using the ‘–sls-file’ flag
- If used, CSI-generated sls_input_file.json file is generally stored in one of two places depending on how far the system is in the install process.
- Early in the install process, when running off of the LiveCD the sls_input_file.json file is normally found in the the directory ‘/var/www/ephemeral/prep/SYSTEMNAME/’
- Later in the install process, the sls_file.json file is generally in ‘/mnt/pitdata/prep/SYSTEMNAME/’
SLS API Input
- To parse the Shasta SLS API for IP addresses, ensure that you have a valid token.
- The token file can either be passed in with the ‘–auth-token TOKEN_FILE’ flag, or it can be automatically read if the environmental variable ‘SLS_TOKEN’ is set.
- The SLS address is default set to ‘api-gw-service-nmn.local’.
- if you are operating on a system with a different address, you can set it with the ‘–sls-address SLS_ADDRESS’ flag.
SHCD Input
- Use the ‘–tabs’ flag to select which tabs on the spreadsheet will be included.
- The ‘–corners’ flag is used to input the upper left and lower right corners of the table on each tab of the worksheet. If the corners are not specified, you will be prompted to enter them for each tab.
- The table should contain the 11 headers: Source, Rack, Location, Slot, (Blank), Port, Destination, Rack, Location, (Blank), Port.
Use the ‘–folder FOLDERNAME’ flag to output all the switch configs to a folder.
noqa: D301, B950
Args:
: ctx: CANU context settings
csm: CSM version
architecture: CSM architecture
ccj: Paddle CCJ file
shcd: SHCD file
tabs: The tabs on the SHCD file to check, e.g. 10G_25G_40G_100G,NMN,HMN.
corners: The corners on each tab, comma separated e.g. ‘J37,U227,J15,T47,J20,U167’.
switch_name: Switch name
sls_file: JSON file containing SLS data
auth_token: Token for SLS authentication
sls_address: The address of SLS
out: Name of the output file
preserve: Folder where switch running configs exist.
custom_config: yaml file containing customized switch configurations which is merged with the generated config.
edge: Vendor of the edge router
reorder: Filters generated configurations through hier_config generate a more natural running-configuration order.
bgp_control_plane: Network used for BGP control plane
vrf: Named VRF used for CSM networks
bond_app_nodes: Generates bonded configuration for application nodes connected the NMN.
log_
: Level of Logging
canu generate switch config [OPTIONS]
Options
--csm
Required CSM network version
- Options: 1.0 | 1.2 | 1.3 | 1.4 | 1.5 | 1.6
-a, --architecture
Required CSM architecture
- Options: Full | TDS | V1
--ccj
Paddle CCJ file
--shcd
SHCD file
--tabs
The tabs on the SHCD file to check, e.g. 10G_25G_40G_100G,NMN,HMN.
--corners
The corners on each tab, comma separated e.g. ‘J37,U227,J15,T47,J20,U167’.
--name
Required The name of the switch to generate config e.g. ‘sw-spine-001’
--sls-file
File containing system SLS JSON data.
--auth-token
Token for SLS authentication
--sls-address
- Default:
'api-gw-service-nmn.local'
--out
Output results to a file
--custom-config
Create and maintain custom switch configurations beyond generated plan-of-record
--edge
Required Vendor of Edge router
- Options: Aruba | Arista
--preserve
Path to current running configs.
--reorder
reorder config to heir config order
--bgp-control-plane
Network used for BGP control plane
- Options: CMN | CHN
--vrf
Named VRF used for CSM networks
--bond-app-nodes
Bond application nodes on the NMN network
--log
Level of logging.
- Options: DEBUG | INFO | WARNING | ERROR
Environment variables
SLS_TOKEN
Provide a default for
--auth-token