TACKER(1)

πŸ“¦
version 2.1.0 Β· 2 versions
, in fedora 43

πŸŽ€ NAME πŸŽ€

tacker β€” the Client for Tacker API πŸ’–

okay so real quick, before we dive in: this whole page is the manual for tacker, and it ships as part of python-tackerclient. That's the vibe. You're in the right place bestie 🫢


🌈 COMMAND LIST 🌈

✨ Command List ✨

This list is the whole extended-command situation for Tacker services that you get inside the openstack command πŸ‘‘

You can pull these up by running openstack help, and if you want the tea on any single command, it's openstack help <command-name> πŸ’…

πŸ’œ [legacy]

  • openstack vim list β€” List VIM(s) that belong to a given tenant.
  • openstack vim register β€” Create a VIM.
  • openstack vim show β€” Show information of a given VIM.
  • openstack vim set β€” Update a given VIM.
  • openstack vim delete β€” Delete given VIM(s).

πŸ’œ [v1] --os-tacker-api-version 1

  • openstack vnf package create β€” Create a new individual VNF package resource.
  • openstack vnf package delete β€” Delete given VNF package(s).
  • openstack vnf package list β€” List all VNF packages.
  • openstack vnf package show β€” Show package details.
  • openstack vnf package upload β€” Upload a VNF package.
  • openstack vnf package download β€” Download a VNF package.
  • openstack vnf package artifact download β€” Download a VNF package artifact.
  • openstack vnf package update β€” Update a state of a VNF package.
  • openstack vnflcm create β€” Create a new VNF instance resource.
  • openstack vnflcm instantiate β€” Instantiate a VNF instance.
  • openstack vnflcm list β€” List VNF instance.
  • openstack vnflcm show β€” Show VNF instance.
  • openstack vnflcm terminate β€” Terminate a VNF instance.
  • openstack vnflcm delete β€” Delete a VNF instance resource.
  • openstack vnflcm heal β€” Heal a VNF instance.
  • openstack vnflcm update β€” Update information of a VNF instance.
  • openstack vnflcm scale β€” Scale a VNF instance.
  • openstack vnflcm change-ext-conn β€” Change external VNF connectivity.
  • openstack vnflcm op rollback β€” Rollback a VNF LCM operation occurrence.
  • openstack vnflcm op retry β€” Retry a VNF LCM operation occurrence.
  • openstack vnflcm op fail β€” Fail a VNF LCM operation occurrence.
  • openstack vnflcm op list β€” List VNF LCM operation occurrence.
  • openstack vnflcm op show β€” Show VNF LCM operation occurrence.
  • openstack vnflcm op cancel β€” Cancel a VNF LCM operation occurrence.
  • openstack vnflcm versions β€” Show VNF LCM API versions.
  • openstack vnflcm subsc create β€” Create new subscription.
  • openstack vnflcm subsc delete β€” Delete subscription.
  • openstack vnflcm subsc list β€” List subscription.
  • openstack vnflcm subsc show β€” Show subscription.

πŸ’œ [v2] --os-tacker-api-version 2

  • openstack vnflcm create β€” Create a new VNF instance resource.
  • openstack vnflcm instantiate β€” Instantiate a VNF instance.
  • openstack vnflcm list β€” List VNF instance.
  • openstack vnflcm show β€” Show VNF instance.
  • openstack vnflcm terminate β€” Terminate a VNF instance.
  • openstack vnflcm delete β€” Delete a VNF instance resource.
  • openstack vnflcm heal β€” Heal a VNF instance.
  • openstack vnflcm update β€” Update information of a VNF instance.
  • openstack vnflcm scale β€” Scale a VNF instance.
  • openstack vnflcm change-ext-conn β€” Change external VNF connectivity.
  • openstack vnflcm change-vnfpkg β€” Change current VNF package.
  • openstack vnflcm op rollback β€” Rollback a VNF LCM operation occurrence.
  • openstack vnflcm op retry β€” Retry a VNF LCM operation occurrence.
  • openstack vnflcm op fail β€” Fail a VNF LCM operation occurrence.
  • openstack vnflcm op list β€” List VNF LCM operation occurrence.
  • openstack vnflcm op show β€” Show VNF LCM operation occurrence.
  • openstack vnflcm versions β€” Show VNF LCM API versions.
  • openstack vnflcm subsc create β€” Create new subscription.
  • openstack vnflcm subsc delete β€” Delete subscription.
  • openstack vnflcm subsc list β€” List subscription.
  • openstack vnflcm subsc show β€” Show subscription.
  • openstack vnffm alarm list β€” List alarm.
  • openstack vnffm alarm show β€” Show alarm.
  • openstack vnffm alarm update β€” Update alarm.
  • openstack vnffm sub create β€” Create FM subscription.
  • openstack vnffm sub list β€” List FM subscription.
  • openstack vnffm sub show β€” Show FM subscription.
  • openstack vnffm sub delete β€” Delete FM subscription.
  • openstack vnfpm job create β€” Create PM job.
  • openstack vnfpm job list β€” List PM job.
  • openstack vnfpm job show β€” Show PM job.
  • openstack vnfpm job update β€” Update PM job.
  • openstack vnfpm job delete β€” Delete PM job.
  • openstack vnfpm report show β€” Show PM report.
  • openstack vnfpm threshold create β€” Create PM threshold.
  • openstack vnfpm threshold list β€” List PM threshold.
  • openstack vnfpm threshold show β€” Show PM threshold.
  • openstack vnfpm threshold update β€” Update PM threshold.
  • openstack vnfpm threshold delete β€” Delete PM threshold.

πŸ¦‹ OPERATIONS FOR ETSI NFV-SOL IMPLEMENTATION πŸ¦‹

πŸ“¦ VNF Package commands πŸ“¦

VNF Package commands are CLI interface of VNF Package Management Interface in ETSI NFV-SOL 005. no cap, that's literally where they come from πŸ’«

πŸ“ vnf package artifact download

Download VNF package artifact of an on-boarded VNF package. it's giving "gimme that artifact" πŸŽ€

openstack vnf package artifact download
    [--file <FILE>]
    <vnf-package>
    <artifact-path>
  • --file <FILE> β€” Local file to save downloaded VNF Package artifact file data. If this is not specified and there is no redirection then data will not be saved. ⚠️ so like, if you forget this and you're not redirecting, your data just… doesn't get saved bestie, watch out
  • vnf-package β€” VNF package ID
  • artifact-path β€” The artifact file's path

This command is provided by the python-tackerclient plugin. 🫢

πŸ“ vnf package create

Create a new VNF Package ✨

openstack vnf package create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--user-data <key=value>]
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.
  • --user-data <key=value> β€” User defined data for the VNF package (repeat option to set multiple user defined data)

This command is provided by the python-tackerclient plugin. πŸ’–

πŸ“ vnf package delete

Delete VNF Package πŸ’€

openstack vnf package delete <vnf-package> [<vnf-package> ...]
  • vnf-package β€” Vnf package(s) ID to delete

This command is provided by the python-tackerclient plugin. 🫢

πŸ“ vnf package download

Download VNF package contents or VNFD of an on-boarded VNF package. 🌸

openstack vnf package download
    [--file <FILE>]
    [--vnfd]
    [--type <type>]
    <vnf-package>
  • --file <FILE> β€” Local file to save downloaded VNF Package or VNFD data. If this is not specified and there is no redirection then data will not be saved.
  • --vnfd β€” Download VNFD of an on-boarded vnf package.
  • --type <type> β€” Provide text/plain when VNFD is implemented as a single YAML file otherwise use application/zip. If you are not aware whether VNFD is a single or multiple yaml files, then you can specify 'both' option value. Provide this option only when --vnfd is set.
  • vnf-package β€” VNF package ID

This command is provided by the python-tackerclient plugin. 🫢

πŸ“ vnf package list

List VNF Packages πŸ‘‘

openstack vnf package list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--filter <filter>]
    [--all_fields | --fields fields | --exclude_fields exclude-fields]
    [--exclude_default]
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --quote <QUOTE_MODE> β€” when to include quotes, defaults to nonnumeric
  • --noindent β€” whether to disable indenting the JSON
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.
  • --sort-column SORT_COLUMN β€” specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
  • --sort-ascending β€” sort the column(s) in ascending order

also chilling up in that synopsis: --sort-descending, --filter <filter>, --all_fields, --fields fields, --exclude_fields exclude-fields and --exclude_default πŸ’…

  • --sort-descending β€” sorts the column(s) the other way round, biggest-to-smallest energy πŸ“‰
  • --filter <filter> β€” the attribute-based-filtering parameters, aka how you tell it what to actually show you πŸ”
  • --all_fields β€” pulls every single complex attribute into the response. no holding back πŸ’…
  • --fields fields β€” the specific complex attributes you do want in the response ✨
  • --exclude_fields exclude-fields β€” the complex attributes you want left out of the response πŸ™ˆ
  • --exclude_default β€” says "exclude all complex attributes from the response". It can be used by itself, or alongside --fields and --filter.
bestie listen: for all other combinations, tacker server will throw a bad request error. so don't get creative with it, okay? 😭

This command is provided by the python-tackerclient plugin.


πŸŽ€ vnf package show πŸŽ€

Show VNF Package Details β€” the lil spotlight moment for one package πŸ‘‘

openstack vnf package show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-package>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.
  • vnf-package β€” VNF package ID

This command is provided by the python-tackerclient plugin.


✨ vnf package update ✨

Update information about an individual VNF package β€” glow-up time πŸ¦‹

openstack vnf package update
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--operational-state <operational-state>]
    [--user-data <key=value>]
    <vnf-package>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.
  • --operational-state <operational-state> β€” Change the operational state of VNF Package. Valid values are 'ENABLED' or 'DISABLED'. that's it, those two, no in-between πŸ’…
  • --user-data <key=value> β€” User defined data for the VNF package (repeat the option to set multiple user defined data)
  • vnf-package β€” VNF package ID

This command is provided by the python-tackerclient plugin.


🌸 vnf package upload 🌸

Upload VNF Package β€” send it, bestie πŸ“€

openstack vnf package upload
    (--path <file> | --url <Uri>)
    [--user-name <user-name>]
    [--password <password>]
    <vnf-package>
  • --path <file> β€” Upload VNF CSAR package from local file
  • --url <Uri> β€” Uri of the VNF package content
  • --user-name <user-name> β€” User name for authentication
  • --password <password> β€” Password for authentication
  • vnf-package β€” VNF package ID

This command is provided by the python-tackerclient plugin.


πŸ’œ VNF Lcm commands πŸ’œ

VNF LCM commands are the CLI interface of the VNF Lifecycle Management Interface in ETSI NFV-SOL 002 and ETSI NFV-SOL 003. iconic spec behaviour, no cap πŸ“š

NOTE: 🚨 Commands call version 1 vnflcm APIs by default. You can call the specific version of vnflcm APIs by using the option --os-tacker-api-version. Commands with --os-tacker-api-version 2 call version 2 vnflcm APIs. vnflcm op cancel is included in only version 1 vnflcm APIs and change-vnfpkg is included in only version 2 vnflcm APIs.

🌈 vnflcm change-ext-conn 🌈

Change External VNF Connectivity β€” rewiring the vibes πŸ”Œ

openstack vnflcm change-ext-conn <vnf-instance> <param-file>
  • vnf-instance β€” VNF instance ID to Change External VNF Connectivity
  • param-file β€” Specify change-ext-conn request parameters in a json file.

This command is provided by the python-tackerclient plugin.


⭐ vnflcm create ⭐

Create a new VNF Instance β€” new instance, who dis πŸ’«

openstack vnflcm create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--name <vnf-instance-name>]
    [--description <vnf-instance-description>]
    [--I <param-file>]
    <vnfd-id>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.
  • --name <vnf-instance-name> β€” Name of the VNF instance to be created.
  • --description <vnf-instance-description> β€” Description of the VNF instance to be created.
  • --I <param-file> β€” Instantiate VNF subsequently after it's creation. Specify instantiate request parameters in a json file.
  • vnfd-id β€” Identifier that identifies the VNFD which defines the VNF instance to be created.

This command is provided by the python-tackerclient plugin.


πŸ’€ vnflcm delete πŸ’€

Delete VNF Instance(s) β€” gone, reduced to atoms πŸ’¨

openstack vnflcm delete <vnf-instance> [<vnf-instance> ...]
  • vnf-instance β€” VNF instance ID(s) to delete

This command is provided by the python-tackerclient plugin.


🧚 vnflcm heal 🧚

Heal VNF Instance β€” the self-care command, fr fr 🩹

openstack vnflcm heal
    [--cause CAUSE]
    [--vnfc-instance <vnfc-instance-id> [<vnfc-instance-id> ...]]
    [--additional-param-file <additional-param-file>]
    <vnf-instance>
  • --cause <CAUSE> β€” Specify the reason why a healing procedure is required.
  • --vnfc-instance <vnfc-instance-id> β€” List of VNFC instances requiring a healing action.
  • --additional-param-file <additional-param-file> β€” Additional parameters passed by the NFVO as input to the healing process.
  • vnf-instance β€” VNF instance ID to heal

This command is provided by the python-tackerclient plugin.


πŸ“ vnflcm instantiate πŸ“

Instantiate a VNF Instance β€” make it real πŸͺ„

openstack vnflcm instantiate <vnf-instance> <param-file>
  • vnf-instance β€” VNF instance ID to instantiate
  • param-file β€” Specify instantiate request parameters in a json file.

This command is provided by the python-tackerclient plugin.


πŸ”₯ vnflcm list πŸ”₯

List VNF Instance β€” the roster, the lineup, the whole cast 🎬

openstack vnflcm list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --quote <QUOTE_MODE> β€” when to include quotes, defaults to nonnumeric
  • --noindent β€” whether to disable indenting the JSON
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.
  • --sort-column SORT_COLUMN β€” specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
  • --sort-ascending β€” sort the column(s) in ascending order
  • --sort-descending β€” sort the column(s) in descending order

This command is provided by the python-tackerclient plugin.


🫢 vnflcm op cancel 🫢

Cancel VNF Instance β€” nvm, abort mission πŸ™…β€β™€οΈ

openstack vnflcm op cancel
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--cancel-mode <cancel-mode>]
    <vnf-lcm-op-occ-id>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.
  • --cancel-mode <cancel-mode> β€” Cancel mode can be 'GRACEFUL' or 'FORCEFUL'. Default is 'GRACEFUL'. graceful is the polite girly way, forceful is the "we're done here" way πŸ’…
  • vnf-lcm-op-occ-id β€” VNF lifecycle management operation occurrence ID.

okay so this one is Fail VNF Instance β€” like, you're telling a VNF that's mid-operation to just… give up πŸ’€

openstack vnflcm op fail
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-lcm-op-occ-id>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format bestie, defaults to table
  • -c COLUMN, --column COLUMN β€” pick which column(s) you wanna see, and you can repeat it to show multiple columns ✨
  • --noindent β€” turns off indenting the JSON
  • --prefix <PREFIX> β€” adds a prefix to all variable names
  • --max-width <integer> β€” max display width, and anything <1 disables it. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence
  • --fit-width β€” fits the table to the display width. It's implied if --max-width is greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” prints an empty table if there's no data to show

vnf-lcm-op-occ-id β€” VNF lifecycle management operation occurrence ID.

This command is provided by the python-tackerclient plugin.


🌸 vnflcm op list 🌸

List LCM Operation Occurrences β€” the receipts of everything that's been happening πŸ‘‘

openstack vnflcm op list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--filter <filter>]
    [--fields <fields> | --exclude-fields <exclude-fields>]
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, repeatable to show multiple columns
  • --quote <QUOTE_MODE> β€” when to include quotes, defaults to nonnumeric
  • --noindent β€” whether to disable indenting the JSON
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.
  • --sort-column SORT_COLUMN β€” specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
  • --sort-ascending β€” sort the column(s) in ascending order
  • --sort-descending β€” sort the column(s) in descending order
  • --filter <filter> β€” Attribute-based-filtering parameters
  • --fields <fields> β€” Complex attributes to be included into the response
  • --exclude-fields <exclude-fields> β€” Complex attributes to be excluded from the response

This command is provided by the python-tackerclient plugin.


πŸ’… vnflcm op retry πŸ’…

Retry VNF Instance β€” second chance energy, we love a comeback arc 🫢

openstack vnflcm op retry <vnf-lcm-op-occ-id>

vnf-lcm-op-occ-id β€” VNF lifecycle management operation occurrence ID.

This command is provided by the python-tackerclient plugin.


πŸ¦‹ vnflcm op rollback πŸ¦‹

openstack vnflcm op rollback <vnf-lcm-op-occ-id>

vnf-lcm-op-occ-id β€” VNF lifecycle management operation occurrence ID.

This command is provided by the python-tackerclient plugin.


✨ vnflcm op show ✨

Display Operation Occurrence details β€” the full tea on one specific op, no crumbs πŸ“

openstack vnflcm op show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-lcm-op-occ-id>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.

vnf-lcm-op-occ-id β€” VNF lifecycle management operation occurrence ID.

This command is provided by the python-tackerclient plugin.


🌈 vnflcm scale 🌈

Scale a VNF Instance β€” bigger or smaller, your call, main character decisions only πŸ‘‘

openstack vnflcm scale
    [--number-of-steps <number-of-steps>]
    [--additional-param-file <additional-param-file>]
    --type <type>
    --aspect-id <aspect-id>
    <vnf-instance>
  • --number-of-steps <number-of-steps> β€” Number of scaling steps to be executed as part of this Scale VNF operation.
  • --additional-param-file <additional-param-file> β€” Additional parameters passed by the NFVO as input to the scaling process.
  • --type <type> β€” SCALE_OUT or SCALE_IN for type of scale operation.
  • --aspect-id <aspect-id> β€” Identifier of the scaling aspect.

vnf-instance β€” VNF instance ID to scale

This command is provided by the python-tackerclient plugin.


πŸŽ€ vnflcm show πŸŽ€

Display VNF instance details β€” everything about one VNF instance, served fresh πŸ’–

openstack vnflcm show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-instance>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.

vnf-instance β€” VNF instance ID to display

This command is provided by the python-tackerclient plugin.


🧚 vnflcm subsc create 🧚

Create a new Lccn Subscription β€” new sub, who dis πŸ’…

openstack vnflcm subsc create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <param-file>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.

param-file β€” Specify create request parameters in a json file.

This command is provided by the python-tackerclient plugin.


πŸ’€ vnflcm subsc delete πŸ’€

Delete Lccn Subscription(s) β€” blocking them, honestly 😭

openstack vnflcm subsc delete <subscription-id> [<subscription-id> ...]

subscription-id β€” Lccn Subscription ID(s) to delete

This command is provided by the python-tackerclient plugin.


⭐ vnflcm subsc list ⭐

List Lccn Subscriptions β€” roll call for every sub you've got 🫢

openstack vnflcm subsc list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--filter <filter>]
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --quote <QUOTE_MODE> β€” when to include quotes, defaults to nonnumeric
  • --noindent β€” whether to disable indenting the JSON
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.
  • --sort-column SORT_COLUMN β€” specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
  • --sort-ascending β€” sort the column(s) in ascending order
  • --sort-descending β€” sort the column(s) in descending order
  • --filter <filter> β€” Attribute-based-filtering parameters

This command is provided by the python-tackerclient plugin.


πŸ’œ vnflcm subsc show πŸ’œ

Display Lccn Subscription details β€” the full breakdown of one sub, iykyk ✨

openstack vnflcm subsc show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <subscription-id>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. ✨
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable 🫢
  • --print-empty β€” Print empty table if there is no data to show. (not the void staring back, bestie πŸ’€)
  • subscription-id β€” Lccn Subscription ID to display πŸ‘‘
This command is provided by the python-tackerclient plugin. πŸŽ€

✨ vnflcm terminate ✨

Terminate a VNF instance. it's giving "we're done here" energy πŸ’…

openstack vnflcm terminate
    [--termination-type <termination-type>]
    [--graceful-termination-timeout <graceful-termination-timeout>]
    [--D]
    <vnf-instance>
  • --termination-type <termination-type> β€” Termination type can be 'GRACEFUL' or 'FORCEFUL'. Default is 'GRACEFUL'. 🌸
  • --graceful-termination-timeout <graceful-termination-timeout> β€” This attribute is only applicable in case of graceful termination. It defines the time to wait for the VNF to be taken out of service before shutting down the VNF and releasing the resources. The unit is seconds. ⏳
  • --D β€” Delete VNF Instance subsequently after it's termination. no take-backsies πŸ—‘οΈ
  • vnf-instance β€” VNF instance ID to terminate.
This command is provided by the python-tackerclient plugin. πŸŽ€

✨ vnflcm update ✨

Update VNF Instance. glow-up time fr fr πŸ’–

openstack vnflcm update [--I <param-file>] <vnf-instance>
  • --I <param-file> β€” Specify update request parameters in a json file. πŸ“„
  • vnf-instance β€” VNF instance ID to update.
This command is provided by the python-tackerclient plugin. πŸŽ€

✨ vnflcm versions ✨

Show VnfLcm Api versions. version check but make it cute πŸ¦‹

openstack vnflcm versions
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--major-version <major-version>]
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table ✨
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns πŸ‘‘
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names πŸŽ€
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable 🫢
  • --print-empty β€” Print empty table if there is no data to show. πŸ’€
  • --major-version <major-version> β€” Show only specify major version. πŸ“
This command is provided by the python-tackerclient plugin. πŸŽ€

✨ vnflcm change-vnfpkg ✨

Change Current VNF Package. new package, who dis πŸ“¦βœ¨

openstack vnflcm change-vnfpkg <vnf-instance> <param-file>
  • vnf-instance β€” VNF instance ID to Change Current VNF Package πŸ‘‘
  • param-file β€” Specify change-vnfpkg request parameters in a json file. πŸ“„
This command is provided by the python-tackerclient plugin. πŸŽ€

🚨 VNF FM commands 🚨

VNF FM commands are CLI interface of VNF Fault Management interface in ‐ ETSI NFV-SOL 002 and ETSI NFV-SOL 003. πŸ‘‘

NOTE: Commands only support calling version 2 vnffm APIs. You can use the commands with --os-tacker-api-version 2 to call version 2 vnffm APIs. ⚠️ no cap, version 2 only bestie

πŸ”” vnffm alarm list πŸ””

List VNF FM alarms. all the alarms, lined up pretty 🌈

openstack vnffm alarm list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--filter <filter>]
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table ✨
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns πŸ‘‘
  • --quote <QUOTE_MODE> β€” when to include quotes, defaults to nonnumeric
  • --noindent β€” whether to disable indenting the JSON
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable 🫢
  • --print-empty β€” Print empty table if there is no data to show. πŸ’€
  • --sort-column SORT_COLUMN β€” specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated πŸŽ€
  • --sort-ascending β€” sort the column(s) in ascending order ⬆️
  • --sort-descending β€” sort the column(s) in descending order ⬇️
  • --filter <filter> β€” Attribute-based-filtering parameters πŸ”
This command is provided by the python-tackerclient plugin. πŸŽ€

πŸ”” vnffm alarm show πŸ””

Display VNF FM alarm details. spill the tea on this alarm β˜•πŸ’…

openstack vnffm alarm show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-fm-alarm-id>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table ✨
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns πŸ‘‘
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names πŸŽ€
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable 🫢
  • --print-empty β€” Print empty table if there is no data to show. πŸ’€
  • vnf-fm-alarm-id β€” VNF FM alarm ID to display πŸ‘‘
This command is provided by the python-tackerclient plugin. πŸŽ€

πŸ”” vnffm alarm update πŸ””

Update information about an individual VNF FM alarm. a little refresh ✨

openstack vnffm alarm update
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--ack-state <ack-state>]
    <vnf-fm-alarm-id>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table ✨
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns πŸ‘‘
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names πŸŽ€
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable 🫢
  • --print-empty β€” Print empty table if there is no data to show. πŸ’€
  • --ack-state <ack-state> β€” Ask state can be 'ACKNOWLEDGED' or 'UNACKNOWLEDGED'. βœ… (yes bestie, the manpage says "Ask state", we keep it exactly like that πŸ’…)
  • vnf-fm-alarm-id β€” VNF FM alarm ID to update.
This command is provided by the python-tackerclient plugin. πŸŽ€

πŸŽ€ vnffm sub create πŸŽ€

Create a new VNF FM subscription. subscribe, but make it VNF πŸ¦‹

openstack vnffm sub create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <param-file>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table ✨
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns πŸ‘‘
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names πŸŽ€
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable 🫢
  • --print-empty β€” Print empty table if there is no data to show. πŸ’€
  • param-file β€” Specify create VNF FM subscription request parameters in a json file. πŸ“„
This command is provided by the python-tackerclient plugin. πŸŽ€

πŸ—‘οΈ vnffm sub delete πŸ—‘οΈ

Delete VNF FM subscription(s). unsubscribe era 😌✨

openstack vnffm sub delete <vnf-fm-sub-id> [<vnf-fm-sub-id> ...]
  • vnf-fm-sub-id β€” VNF FM subscription ID(s) to delete (yes, plural, you can stack 'em) πŸ‘‘
This command is provided by the python-tackerclient plugin. πŸŽ€

🌸 vnffm sub list 🌸

List VNF FM subs. the whole subscription roster 🌈

openstack vnffm sub list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--filter <filter>]
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table ✨
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns πŸ‘‘
  • --quote <QUOTE_MODE> β€” when to include quotes, defaults to nonnumeric
  • --noindent β€” whether to disable indenting the JSON
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable 🫢
  • --print-empty β€” Print empty table if there is no data to show. πŸ’€
  • --sort-column SORT_COLUMN β€” tell it which column(s) to sort by, bestie πŸ’… (the columns you name first get priority, and any column that doesn't actually exist just gets silently ignored β€” rude but true), and yeah you can stack this one up by repeating it
  • --sort-ascending β€” sort those column(s) smallest-to-biggest, ascending vibes only ⬆️
  • --sort-descending β€” sort those column(s) biggest-to-smallest, descending slay ⬇️
  • --filter <filter> β€” your attribute-based-filtering parameters, for when you need to be ✨specific✨

This command is provided by the python-tackerclient plugin.


vnffm sub show 🌸

Display VNF FM subscription details β€” the whole lil recap of one sub, served fresh πŸ’–

openstack vnffm sub show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-fm-sub-id>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format you want, and it defaults to table
  • -c COLUMN, --column COLUMN β€” pick which column(s) to include, and repeat it to show multiple columns at once
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” slaps a prefix onto all the variable names
  • --max-width <integer> β€” maximum display width, and anything <1 disables it. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but heads up: the parameter takes precedence πŸ‘‘
  • --fit-width β€” fits the table to the display width. It's implied if --max-width is greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable it
  • --print-empty β€” prints an empty table if there's no data to show, no cap 🫢
  • vnf-fm-sub-id β€” the VNF FM subscription ID to display

This command is provided by the python-tackerclient plugin.


VNF PM commands πŸ”₯

VNF PM commands are the CLI interface of the VNF Performance Management interface in ETSI NFV-SOL 002 and ETSI NFV-SOL 003. Performance management era, periodt ✨

NOTE: Commands only support calling version 2 vnfpm APIs. You can use the commands with --os-tacker-api-version 2 to call version 2 vnfpm APIs. (Yes this matters, don't skip it bestie 😭)

vnfpm job create πŸŽ€

Create a new VNF PM job β€” a whole new task enters the chat

openstack vnfpm job create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <param-file>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.
  • param-file β€” Specify create VNF PM job request parameters in a json file. πŸ“„

This command is provided by the python-tackerclient plugin.

vnfpm job delete πŸ’€

Delete VNF PM job β€” bye bestie, it's giving gone πŸ’…

openstack vnfpm job delete <vnf-pm-job-id> [<vnf-pm-job-id> ...]
  • vnf-pm-job-id β€” VNF PM job ID(s) to delete

This command is provided by the python-tackerclient plugin.

vnfpm job list 🌈

List VNF PM jobs β€” the full roll call, main character energy

openstack vnfpm job list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--filter <filter>]
    [--all_fields | --fields fields | --exclude_fields exclude-fields]
    [--exclude_default]
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --quote <QUOTE_MODE> β€” when to include quotes, defaults to nonnumeric
  • --noindent β€” whether to disable indenting the JSON
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.
  • --sort-column SORT_COLUMN β€” specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
  • --sort-ascending β€” sort the column(s) in ascending order
  • --sort-descending β€” sort the column(s) in descending order
  • --filter <filter> β€” Attribute-based-filtering parameters
  • --all_fields β€” Include all complex attributes in the response
  • --fields fields β€” Complex attributes to be included into the response
  • --exclude_fields exclude-fields β€” Complex attributes to be excluded from the response
  • --exclude_default β€” Indicates to exclude all complex attributes from the response. This argument can be used alone or with --fields and --filter. For all other combinations tacker server will throw bad request error 🚨

This command is provided by the python-tackerclient plugin.

vnfpm job show ✨

Display VNF PM job details β€” the glow-up close-up of one job

openstack vnfpm job show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-pm-job-id>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.
  • vnf-pm-job-id β€” VNF PM job ID to display

This command is provided by the python-tackerclient plugin.

vnfpm job update πŸ¦‹

Update information about an individual VNF PM job β€” a lil refresh, a lil edit, we love to see it

openstack vnfpm job update
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-pm-job-id>
    <param-file>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.
  • vnf-pm-job-id β€” VNF PM job ID to update.
  • param-file β€” Specify update PM job request parameters in a json file. πŸ“„

This command is provided by the python-tackerclient plugin.

vnfpm report show πŸ“

Display VNF PM report details β€” receipts, but make it performance management

openstack vnfpm report show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-pm-job-id>
    <vnf-pm-report-id>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.
  • vnf-pm-job-id β€” VNF PM job id where the VNF PM report is located
  • vnf-pm-report-id β€” VNF PM report ID to display

This command is provided by the python-tackerclient plugin.

vnfpm threshold create πŸ‘‘

Create a new VNF PM threshold β€” set the limit, set the boundary, iconic behaviour fr fr

openstack vnfpm threshold create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <param-file>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format, defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.
  • param-file β€” drop your create VNF PM threshold request params in a json file, bestie. That's the whole assignment. πŸ“„βœ¨

This command is provided by the python-tackerclient plugin.


πŸ’… vnfpm threshold delete

Okay so we're deleting a VNF PM threshold. Bye bestie, you will not be missed 🫢

openstack vnfpm threshold delete
    <vnf-pm-threshold-id>
    [<vnf-pm-threshold-id> ...]
  • vnf-pm-threshold-id β€” the VNF PM threshold ID(s) you wanna delete. Yes plural, you can stack them. Go off. πŸ’€

This command is provided by the python-tackerclient plugin.</purl>


✨ vnfpm threshold list

Listing all the VNF PM thresholds, like scrolling the group chat and seeing every single one πŸŽ€

openstack vnfpm threshold list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--filter <filter>]
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format. defaults to table. pick your aesthetic, no wrong answers 🌈
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include. can be repeated to show multiple columns, so go ahead and collect them all πŸ’…
  • --quote <QUOTE_MODE> β€” when to include quotes. defaults to nonnumeric
  • --noindent β€” whether to disable indenting the JSON. flat vibes only fr
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. πŸ‘‘
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show. the void, but make it formatted ✨
  • --sort-column SORT_COLUMN β€” specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
  • --sort-ascending β€” sort the column(s) in ascending order ⬆️
  • --sort-descending β€” sort the column(s) in descending order ⬇️
  • --filter <filter> β€” Attribute-based-filtering parameters

This command is provided by the python-tackerclient plugin.


πŸ”₯ vnfpm threshold show

Display the details of one VNF PM threshold. main character reveal moment ngl 🫢

openstack vnfpm threshold show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-pm-threshold-id>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format. defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names 🏷️
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.
  • vnf-pm-threshold-id β€” the VNF PM threshold ID to display πŸ’–

This command is provided by the python-tackerclient plugin.


πŸ¦‹ vnfpm threshold update

Updating the info on one specific VNF PM threshold. glow-up arc, activated 🌸

openstack vnfpm threshold update
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-pm-threshold-id>
    <param-file>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format. defaults to table
  • -c COLUMN, --column COLUMN β€” specify the column(s) to include, can be repeated to show multiple columns
  • --noindent β€” whether to disable indenting the JSON
  • --prefix <PREFIX> β€” add a prefix to all variable names
  • --max-width <integer> β€” Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
  • --fit-width β€” Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
  • --print-empty β€” Print empty table if there is no data to show.
  • vnf-pm-threshold-id β€” the VNF PM threshold ID to update. 🎯
  • param-file β€” Specify update PM threshold request parameters in a json file. yes bestie, json file again. that's just how we do it here πŸ’…

This command is provided by the python-tackerclient plugin.

πŸ‘‘ OPERATIONS FOR LEGACY IMPLEMENTATION πŸ‘‘

Okay bestie, this is the legacy corner of the club β€” the classics, the originals, the ones that still go hard. πŸ’…


πŸ¦‹ VIM Management commands πŸ¦‹

These are your VIM-wrangling commands, brought to you by the python-tackerclient plugin. Let's get into it.


🌟 vim delete 🌟

Say bye-bye to VIM(s). Like, actually delete them. No undo button, so vibe check yourself first. 😭

openstack vim delete <VIM> [<VIM> ...]
  • VIM β€” VIM(s) to delete, given as a name or an ID
This command is provided by the python-tackerclient plugin.

🌟 vim list 🌟

Lists every VIM that belongs to a given tenant. Like a lil roll call for your VIMs. ✨

openstack vim list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--long]
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format you want, and it defaults to table
  • -c COLUMN, --column COLUMN β€” pick the column(s) to include; repeat it as many times as you want to show multiple columns
  • --quote <QUOTE_MODE> β€” decides when to include quotes, defaults to nonnumeric
  • --noindent β€” turns off indenting for the JSON
  • --max-width <integer> β€” the maximum display width, and anything <1 disables it. You can also set the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter wins if they fight πŸ’…
  • --fit-width β€” fits the table to your display width. It's implied if --max-width is greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always have it on
  • --print-empty β€” prints an empty table when there's literally no data to show
  • --sort-column SORT_COLUMN β€” pick the column(s) to sort the data by (columns listed first get priority, and non-existing columns just get ignored); can be repeated
  • --sort-ascending β€” sorts the column(s) in ascending order
  • --sort-descending β€” sorts the column(s) in descending order
  • --long β€” lists additional fields in the output
This command is provided by the python-tackerclient plugin.

🌟 vim register 🌟

Register a brand new VIM. New VIM, who dis? πŸŽ€

openstack vim register
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    --config-file CONFIG_FILE
    [--description DESCRIPTION]
    [--is-default]
    NAME
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format you want, and it defaults to table
  • -c COLUMN, --column COLUMN β€” pick the column(s) to include; repeat it as many times as you want to show multiple columns
  • --noindent β€” turns off indenting for the JSON
  • --prefix <PREFIX> β€” adds a prefix to all variable names
  • --max-width <integer> β€” the maximum display width, and anything <1 disables it. You can also set the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter wins if they fight πŸ’…
  • --fit-width β€” fits the table to your display width. It's implied if --max-width is greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always have it on
  • --print-empty β€” prints an empty table when there's literally no data to show
  • --tenant-id TENANT_ID β€” the owner tenant ID or project ID
  • --config-file <CONFIG_FILE> β€” a YAML file with the VIM configuration parameters
  • --description <DESCRIPTION> β€” sets a description for the VIM
  • --is-default β€” sets it as the default VIM
  • NAME β€” sets a name for the VIM
This command is provided by the python-tackerclient plugin.

🌟 vim set 🌟

Update a VIM. Glow-up time. ✨

openstack vim set
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--config-file CONFIG_FILE]
    [--name NAME]
    [--description DESCRIPTION]
    [--is-default {True,False}]
    VIM
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format you want, and it defaults to table
  • -c COLUMN, --column COLUMN β€” pick the column(s) to include; repeat it as many times as you want to show multiple columns
  • --noindent β€” turns off indenting for the JSON
  • --prefix <PREFIX> β€” adds a prefix to all variable names
  • --max-width <integer> β€” the maximum display width, and anything <1 disables it. You can also set the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter wins if they fight πŸ’…
  • --fit-width β€” fits the table to your display width. It's implied if --max-width is greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always have it on
  • --print-empty β€” prints an empty table when there's literally no data to show
  • --config-file <CONFIG_FILE> β€” a YAML file with the VIM configuration parameters
  • --name <NAME> β€” a new name for the VIM
  • --description <DESCRIPTION> β€” a new description for the VIM
  • --is-default {True,False} β€” indicates whether the VIM is used as the default
  • VIM β€” the ID or name of the vim to update
This command is provided by the python-tackerclient plugin.

🌟 vim show 🌟

Display the deets on a VIM. Main character reveal. πŸ‘‘

openstack vim show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <VIM>
  • -f <FORMATTER>, --format <FORMATTER> β€” the output format you want, and it defaults to table
  • -c COLUMN, --column COLUMN β€” pick the column(s) to include; repeat it as many times as you want to show multiple columns
  • --noindent β€” turns off indenting for the JSON
  • --prefix <PREFIX> β€” adds a prefix to all variable names
  • --max-width <integer> β€” the maximum display width, and anything <1 disables it. You can also set the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter wins if they fight πŸ’…
  • --fit-width β€” fits the table to your display width. It's implied if --max-width is greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always have it on
  • --print-empty β€” prints an empty table when there's literally no data to show
  • VIM β€” the VIM to display (name or ID)
This command is provided by the python-tackerclient plugin.

🫢 AUTHOR 🫢

OpenStack Contributors πŸ’–


OpenStack Contributors


And that's a wrap, bestie!! πŸŽ‰ This whole iconic page is version 2.1.0, dated Sep 19, 2025, and it lives in the TACKER(1) manual. Go forth and slay your VIMs. πŸ’…βœ¨πŸ¦‹

πŸ“¦ where this page comes from