contrail-api-cli documentation

contrail-api-cli is a command line tool which interact with the contrail API server.

contrail-api-cli provides a shell like experience with unix style commands to browse or modify API resources and collections.

• Connecting to the API server
  • Basic auth on localhost:8095
  • Keystone auth on API_SERVER:8082
• Base commands
  • help
  • man
  • ls
  • du
  • cd
  • cat
  • tree
  • rm
  • edit
  • schema
  • ln
  • relative
  • kv
• Advanced usage
  • pipes
  • direct-call
  • wildcard resolution
  • loading commands from other namespaces
  • python from the shell
  • python script execution
• Howto write a command
  • Setup your project
  • Hello world command
• Using Resource and Collection API in commands
  • Resource and Collection objects
  • virtual-router resource
  • List command
  • Add command
  • Del command
• API
  • Collection
  • Resource
  • Command
  • Utils

Indices and tables

• Index
• Module Index
• Search Page