f5-entoli

f5 oss cli

notes

command (english) => εντολή (entoli -> greek)

F5 Open sourcee command line interface based on vscode-f5 extension capabilities

Goals

• provide an open source cli that utilizes functionality found in vscode-f5 and vscode-f5-chariot that can be integrated in other solutions like repo actions
  • Can also be used with vscode to deploy an entire repo
• mirror some of the original F5-cli functionality/flow
  • https://clouddocs.f5.com/sdk/f5-cli/
  • https://github.com/f5devcentral/f5-sdk-python
  • https://hub.docker.com/r/f5devcentral/f5-cli
• take heavy inspiration from kubectl form and function
  • heavy focus on declarative work flows
  • support different config object output types like json and yaml
  • support yaml input files

Table of Contents

• notes
• Table of Contents
• Usage
• Commands

Usage

$ npm install -g f5-entoli
$ entoli COMMAND
running command...
$ entoli (-v|--version|version)
f5-entoli/0.1.0 linux-x64 node-v14.18.2
$ entoli --help [COMMAND]
USAGE
  $ entoli COMMAND
...

Commands

• entoli as3:declare [FILE]
• entoli as3:delete
• entoli autocomplete [SHELL]
• entoli commands
• entoli declare
• entoli devices:add [DEVICE]
• entoli devices:list
• entoli help [COMMAND]
• entoli info

entoli as3:declare [FILE]

post as3 file (or directory)

USAGE
  $ entoli as3:declare [FILE]

ARGUMENTS
  FILE  as3 file to declare

OPTIONS
  -d, --device=device      (required) device to as3 with
  -h, --help               show CLI help
  -p, --password=password  password for provided username
  -u, --username=username  [default: admin] username to connect to device with
  -v, --provider=provider  [default: tmos] device provider
  --port=port              [default: 443] device port

See code: src/commands/as3/declare.ts

entoli as3:delete

describe the command here

USAGE
  $ entoli as3:delete

OPTIONS
  -d, --device=device      (required) device to as3 with
  -h, --help               show CLI help
  -l, --listTenant         list existing tenants to select
  -p, --password=password  password for provided username
  -t, --tenant=tenant      as3 tenant to delete/remove
  -u, --username=username  [default: admin] username to connect to device with
  -v, --provider=provider  [default: tmos] device provider
  --port=port              [default: 443] device port

See code: src/commands/as3/delete.ts

entoli autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ entoli autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ entoli autocomplete
  $ entoli autocomplete bash
  $ entoli autocomplete zsh
  $ entoli autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

entoli commands

list all the commands

USAGE
  $ entoli commands

OPTIONS
  -h, --help              Show CLI help.
  -j, --json              display unfiltered api data in json format
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --hidden                show hidden commands
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

See code: @oclif/plugin-commands

entoli declare

declare environment via AS3/DO

USAGE
  $ entoli declare

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ entoli up
  $ entoli deploy

See code: src/commands/declare.ts

entoli devices:add [DEVICE]

describe the command here

USAGE
  $ entoli devices:add [DEVICE]

ARGUMENTS
  DEVICE  device/hostname/ip

OPTIONS
  -h, --help               show CLI help
  -p, --password=password  password

See code: src/commands/devices/add.ts

entoli devices:list

list known devices -> known devices have cached passwords

USAGE
  $ entoli devices:list

OPTIONS
  -h, --help  show CLI help

See code: src/commands/devices/list.ts

entoli help [COMMAND]

display help for entoli

USAGE
  $ entoli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

entoli info

Project version and environment details

USAGE
  $ entoli info

OPTIONS
  -h, --help  show CLI help

See code: src/commands/info.ts