Purpose
Use NextIO CLI commands to inspect service diagrams, validate a diagram, start or stop services, apply changes, and perform simple diagram editing from 01sh.
Show NextIO Services
show nextio
Purpose: list known NextIO services and their state.
Syntax:
show nextio
Typical help output includes service names, files, paths, and state:
<Enter> - Press Enter to show NextIO services
LB to Ports - clixer-agg-lb.nio | /home/admin/Workspace/NextIO_Services/clixer-agg-lb.nio | Active
p1-egress-filter-to-p2 - p1-egress-filter-to-p2.nio | /home/admin/Workspace/NextIO_Services/SystemTests/p1-egress-filter-to-p2.nio | Inactive
show nextio
Purpose: display one service. The selector can be a visible service name or a path offered by the command help.
Use:
show nextio ?
to list current choices.
Service Lifecycle Commands
The exec nextio ? command lists:
apply - Apply changes from a NextIO diagram file
start - Start a NextIO service domain from a diagram file
stop - Stop a NextIO service domain from a diagram file
verify - Verify a NextIO diagram file without execution
exec nextio verify
Purpose: validate a service diagram without starting it.
Syntax pattern:
exec nextio verify <diagram>
exec nextio start
Purpose: start a service domain from a diagram file.
Syntax pattern:
exec nextio start <diagram>
Typical output:
Task is started at /home/infinicore/ivos/workflows/startNIOServiceDomainFromDiagram/<id>
Start service from diagram /home/admin/Workspace/NextIO_Services/LB.nio...
...
Task execution completed
exec nextio stop
Purpose: stop a running service domain.
Syntax pattern:
exec nextio stop <diagram-or-service>
exec nextio apply
Purpose: apply changes from a NextIO diagram file to an existing service.
Syntax pattern:
exec nextio apply <diagram>
Diagram File Commands
The config nextio ? command lists:
add - Add a NextIO diagram optionally from a template
edit - Open a NextIO diagram for editing
remove - Remove a NextIO diagram file
config nextio add
Purpose: create a new NextIO diagram, optionally from a template.
config nextio edit
Purpose: open a NextIO diagram in the CLI editor.
config nextio remove
Purpose: remove a NextIO diagram file.
Use ? to list available parameters and file selectors:
config nextio edit ?
CLI NextIO Editor
When config nextio edit opens a diagram, 01sh enters a NextIO editor session.
The editor has its own local commands:
| Command | Purpose |
|---|---|
add_comp <comp_type> <comp_name> |
Add a component. |
edit <comp_name> <property_name> |
Edit a component property. |
del_comp <comp_name> |
Delete a component. |
connect <from> <to> |
Connect components. |
layout |
Lay out components left-to-right. |
show |
Show editor information. |
save |
Save the current NextIO document. |
exit |
Exit the current editor session or nested editor state. |
The editor show command supports:
| Command | Purpose |
|---|---|
show all |
Show all components and properties. |
show comp_type <type> |
Show components of one type. |
show comp_name <name> |
Show one component and its properties. |
show conns |
Show logical component connections. |
show layout |
Preview current layout. |
Use ? inside the editor to list context-specific editor commands.
Notes
- Starting or applying a service may configure vfabric, packet filters, multicast, counters, or port usage state.
- If a service fails to start, the workflow output normally reports the failed component and backend command.
- Some NextIO services can share an ingress port only when the diagram supports that behavior.