NFV Orchestration service command-line client¶

tacker chain-list¶

usage: tacker chain-list [-h] [-f {csv,html,json,table,value,yaml}]
                         [-c COLUMN] [--max-width <integer>] [--noindent]
                         [--quote {all,minimal,none,nonnumeric}]
                         [--request-format {json,xml}] [-D] [-F FIELD]

List SFCs that belong to a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker chain-show¶

usage: tacker chain-show [-h] [-f {html,json,shell,table,value,yaml}]
                         [-c COLUMN] [--max-width <integer>] [--noindent]
                         [--prefix PREFIX] [--request-format {json,xml}] [-D]
                         [-F FIELD]
                         SFC

Show information of a given SFC.

Positional arguments:

SFC

ID or name of sfc to look up

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker classifier-list¶

usage: tacker classifier-list [-h] [-f {csv,html,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--request-format {json,xml}] [-D] [-F FIELD]

List FCs that belong to a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker classifier-show¶

usage: tacker classifier-show [-h] [-f {html,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX] [--request-format {json,xml}]
                              [-D] [-F FIELD]
                              CLASSIFIER

Show information of a given FC.

Positional arguments:

CLASSIFIER

ID or name of classifier to look up

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker event-show¶

usage: tacker event-show [-h] [-f {html,json,shell,table,value,yaml}]
                         [-c COLUMN] [--max-width <integer>] [--noindent]
                         [--prefix PREFIX] [--request-format {json,xml}] [-D]
                         [-F FIELD]
                         EVENT

Show event given the event id.

Positional arguments:

EVENT

ID or name of event to look up

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker events-list¶

usage: tacker events-list [-h] [-f {csv,html,json,table,value,yaml}]
                          [-c COLUMN] [--max-width <integer>] [--noindent]
                          [--quote {all,minimal,none,nonnumeric}]
                          [--request-format {json,xml}] [-D] [-F FIELD]

List events that belong to a given resource. The supported args are --id, --resource_id, --resource_state, --resource_type, --event_type

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker ext-list¶

usage: tacker ext-list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN]
                       [--max-width <integer>] [--noindent]
                       [--quote {all,minimal,none,nonnumeric}]
                       [--request-format {json,xml}] [-D] [-F FIELD]

List all extensions.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker ext-show¶

usage: tacker ext-show [-h] [-f {html,json,shell,table,value,yaml}]
                       [-c COLUMN] [--max-width <integer>] [--noindent]
                       [--prefix PREFIX] [--request-format {json,xml}] [-D]
                       [-F FIELD]
                       EXT-ALIAS

Show information of a given resource.

Positional arguments:

EXT-ALIAS

ID of extension to look up

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker nfp-list¶

usage: tacker nfp-list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN]
                       [--max-width <integer>] [--noindent]
                       [--quote {all,minimal,none,nonnumeric}]
                       [--request-format {json,xml}] [-D] [-F FIELD]

List NFPs that belong to a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker nfp-show¶

usage: tacker nfp-show [-h] [-f {html,json,shell,table,value,yaml}]
                       [-c COLUMN] [--max-width <integer>] [--noindent]
                       [--prefix PREFIX] [--request-format {json,xml}] [-D]
                       [-F FIELD]
                       NFP

Show information of a given NFP.

Positional arguments:

NFP

ID or name of nfp to look up

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker vim-delete¶

usage: tacker vim-delete [-h] [--request-format {json,xml}] VIM

Delete a given VIM.

Positional arguments:

VIM

ID or name of vim to delete

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

tacker vim-events-list¶

usage: tacker vim-events-list [-h] [-f {csv,html,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--request-format {json,xml}] [-D] [-F FIELD]

List events that belong to a given VIM. The supported args are --id, --resource_id, --resource_state, --event_type

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker vim-list¶

usage: tacker vim-list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN]
                       [--max-width <integer>] [--noindent]
                       [--quote {all,minimal,none,nonnumeric}]
                       [--request-format {json,xml}] [-D] [-F FIELD]

List VIMs that belong to a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker vim-register¶

usage: tacker vim-register [-h] [-f {html,json,shell,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--noindent]
                           [--prefix PREFIX] [--request-format {json,xml}]
                           [--tenant-id TENANT_ID] --config-file CONFIG_FILE
                           [--description DESCRIPTION] [--is-default]
                           NAME

Create a VIM.

Positional arguments:

NAME

Set a name for the VIM

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

--tenant-id TENANT_ID

The owner tenant ID

--config-file CONFIG_FILE

Specify VIM specific config parameters in a file

--description DESCRIPTION

Set a description for the VIM

--is-default

Set as default VIM

tacker vim-show¶

usage: tacker vim-show [-h] [-f {html,json,shell,table,value,yaml}]
                       [-c COLUMN] [--max-width <integer>] [--noindent]
                       [--prefix PREFIX] [--request-format {json,xml}] [-D]
                       [-F FIELD]
                       VIM

Show information of a given VIM.

Positional arguments:

VIM

ID or name of vim to look up

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker vim-update¶

usage: tacker vim-update [-h] [--request-format {json,xml}]
                         [--config-file CONFIG_FILE] [--is-default]
                         VIM

Update a given VIM.

Positional arguments:

VIM

ID or name of vim to update

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

--config-file CONFIG_FILE

Specify VIM specific config parameters in a file

--is-default

Set as default VIM

tacker vnf-create¶

usage: tacker vnf-create [-h] [-f {html,json,shell,table,value,yaml}]
                         [-c COLUMN] [--max-width <integer>] [--noindent]
                         [--prefix PREFIX] [--request-format {json,xml}]
                         [--tenant-id TENANT_ID] [--description DESCRIPTION]
                         (--vnfd-id VNFD_ID | --vnfd-name VNFD_NAME)
                         [--vim-id VIM_ID | --vim-name VIM_NAME]
                         [--vim-region-name VIM_REGION_NAME]
                         [--config-file CONFIG_FILE] [--config CONFIG]
                         [--param-file PARAM_FILE]
                         NAME

Create a VNF.

Positional arguments:

NAME

Set a name for the VNF

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

--tenant-id TENANT_ID

The owner tenant ID

--description DESCRIPTION

Set description for the VNF

--vnfd-id VNFD_ID

VNFD ID to use as template to create VNF

--vnfd-name VNFD_NAME

VNFD Name to use as template to create VNF

--vim-id VIM_ID

VIM ID to use to create VNF on the specified VIM

--vim-name VIM_NAME

VIM name to use to create VNF on the specified VIM

--vim-region-name VIM_REGION_NAME

VIM Region to use to create VNF on the specified VIM

--config-file CONFIG_FILE

Specify config yaml file

--config CONFIG

Specify config yaml data

--param-file PARAM_FILE

Specify parameter yaml file

tacker vnf-delete¶

usage: tacker vnf-delete [-h] [--request-format {json,xml}] VNF

Delete a given VNF.

Positional arguments:

VNF

ID or name of vnf to delete

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

tacker vnf-events-list¶

usage: tacker vnf-events-list [-h] [-f {csv,html,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--request-format {json,xml}] [-D] [-F FIELD]

List events that belong to a given VNF. The supported args are --id, --resource_id, --resource_state, --event_type

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker vnf-list¶

usage: tacker vnf-list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN]
                       [--max-width <integer>] [--noindent]
                       [--quote {all,minimal,none,nonnumeric}]
                       [--request-format {json,xml}] [-D] [-F FIELD]

List VNF that belong to a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker vnf-resource-list¶

usage: tacker vnf-resource-list [-h] [-f {csv,html,json,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--request-format {json,xml}] [-D] [-F FIELD]
                                VNF

List resources of a VNF like VDU, CP, etc.

Positional arguments:

VNF

ID or name of vnf to look up

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker vnf-scale¶

usage: tacker vnf-scale [-h] [--request-format {json,xml}]
                        (--vnf-id VNF_ID | --vnf-name VNF_NAME)
                        [--scaling-policy-name SCALING_POLICY_NAME]
                        [--scaling-type SCALING_TYPE]

Scale a VNF.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

--vnf-id VNF_ID

VNF ID

--vnf-name VNF_NAME

VNF name

--scaling-policy-name SCALING_POLICY_NAME

VNF policy name used to scale

--scaling-type SCALING_TYPE

VNF scaling type, it could be either “out” or “in”

tacker vnf-show¶

usage: tacker vnf-show [-h] [-f {html,json,shell,table,value,yaml}]
                       [-c COLUMN] [--max-width <integer>] [--noindent]
                       [--prefix PREFIX] [--request-format {json,xml}] [-D]
                       [-F FIELD]
                       VNF

Show information of a given VNF.

Positional arguments:

VNF

ID or name of vnf to look up

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker vnf-update¶

usage: tacker vnf-update [-h] [--request-format {json,xml}]
                         [--config-file CONFIG_FILE] [--config CONFIG]
                         VNF

Update a given VNF.

Positional arguments:

VNF

ID or name of vnf to update

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

--config-file CONFIG_FILE

Specify config yaml file

--config CONFIG

Specify config yaml data

tacker vnfd-create¶

usage: tacker vnfd-create [-h] [-f {html,json,shell,table,value,yaml}]
                          [-c COLUMN] [--max-width <integer>] [--noindent]
                          [--prefix PREFIX] [--request-format {json,xml}]
                          [--tenant-id TENANT_ID]
                          (--vnfd-file VNFD_FILE | --vnfd VNFD)
                          [--description DESCRIPTION]
                          NAME

Create a VNFD.

Positional arguments:

NAME

Set a name for the VNFD

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

--tenant-id TENANT_ID

The owner tenant ID

--vnfd-file VNFD_FILE

Specify VNFD file

--vnfd VNFD

Specify VNFD

--description DESCRIPTION

Set a description for the VNFD

tacker vnfd-delete¶

usage: tacker vnfd-delete [-h] [--request-format {json,xml}] VNFD

Delete a given VNFD.

Positional arguments:

VNFD

ID or name of vnfd to delete

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

tacker vnfd-events-list¶

usage: tacker vnfd-events-list [-h] [-f {csv,html,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--request-format {json,xml}] [-D] [-F FIELD]

List events that belong to a given VNFD. The supported args are --id, --resource_id, --resource_state, --event_type

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker vnfd-list¶

usage: tacker vnfd-list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN]
                        [--max-width <integer>] [--noindent]
                        [--quote {all,minimal,none,nonnumeric}]
                        [--request-format {json,xml}] [-D] [-F FIELD]

List VNFD that belong to a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker vnfd-show¶

usage: tacker vnfd-show [-h] [-f {html,json,shell,table,value,yaml}]
                        [-c COLUMN] [--max-width <integer>] [--noindent]
                        [--prefix PREFIX] [--request-format {json,xml}] [-D]
                        [-F FIELD]
                        VNFD

Show information of a given VNFD.

Positional arguments:

VNFD

ID or name of vnfd to look up

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker vnfd-template-show¶

usage: tacker vnfd-template-show [-h] [-f {html,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [--request-format {json,xml}] [-D] [-F FIELD]
                                 VNFD

Show template of a given VNFD.

Positional arguments:

VNFD

ID or name of vnfd to look up

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker vnffg-create¶

usage: tacker vnffg-create [-h] [-f {html,json,shell,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--noindent]
                           [--prefix PREFIX] [--request-format {json,xml}]
                           [--tenant-id TENANT_ID]
                           (--vnffgd-id VNFFGD_ID | --vnffgd-name VNFFGD_NAME)
                           [--vnf-mapping VNF_MAPPING]
                           [--symmetrical {True,False}]
                           NAME

Create a VNFFG.

Positional arguments:

NAME

Set a name for the VNFFG

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

--tenant-id TENANT_ID

The owner tenant ID

--vnffgd-id VNFFGD_ID

VNFFGD ID to use as template to create VNFFG

--vnffgd-name VNFFGD_NAME

VNFFGD Name to use as template to create VNFFG

--vnf-mapping VNF_MAPPING

List of logical VNFD name to VNF instance name mapping. Example: VNF1:my_vnf1,VNF2:my_vnf2

--symmetrical {True,False}

Should a reverse path be created for the NFP

tacker vnffg-delete¶

usage: tacker vnffg-delete [-h] [--request-format {json,xml}] VNFFG

Delete a given VNFFG.

Positional arguments:

VNFFG

ID or name of vnffg to delete

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

tacker vnffg-list¶

usage: tacker vnffg-list [-h] [-f {csv,html,json,table,value,yaml}]
                         [-c COLUMN] [--max-width <integer>] [--noindent]
                         [--quote {all,minimal,none,nonnumeric}]
                         [--request-format {json,xml}] [-D] [-F FIELD]

List VNFFGs that belong to a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker vnffg-show¶

usage: tacker vnffg-show [-h] [-f {html,json,shell,table,value,yaml}]
                         [-c COLUMN] [--max-width <integer>] [--noindent]
                         [--prefix PREFIX] [--request-format {json,xml}] [-D]
                         [-F FIELD]
                         VNFFG

Show information of a given VNFFG.

Positional arguments:

VNFFG

ID or name of vnffg to look up

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker vnffg-update¶

usage: tacker vnffg-update [-h] [--request-format {json,xml}]
                           [--vnf-mapping VNF_MAPPING]
                           [--symmetrical {True,False}]
                           VNFFG

Update a given VNFFG.

Positional arguments:

VNFFG

ID or name of vnffg to update

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

--vnf-mapping VNF_MAPPING

List of logical VNFD name to VNF instance name mapping. Example: VNF1:my_vnf1,VNF2:my_vnf2

--symmetrical {True,False}

Should a reverse path be created for the NFP

tacker vnffgd-create¶

usage: tacker vnffgd-create [-h] [-f {html,json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--prefix PREFIX] [--request-format {json,xml}]
                            [--tenant-id TENANT_ID]
                            (--vnffgd-file VNFFGD_FILE | --vnffgd VNFFGD)
                            [--description DESCRIPTION]
                            NAME

Create a VNFFGD.

Positional arguments:

NAME

Set a name for the VNFFGD

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

--tenant-id TENANT_ID

The owner tenant ID

--vnffgd-file VNFFGD_FILE

Specify VNFFGD file

--vnffgd VNFFGD

Specify VNFFGD

--description DESCRIPTION

Set a description for the VNFFGD

tacker vnffgd-delete¶

usage: tacker vnffgd-delete [-h] [--request-format {json,xml}] VNFFGD

Delete a given VNFFGD.

Positional arguments:

VNFFGD

ID or name of vnffgd to delete

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

tacker vnffgd-list¶

usage: tacker vnffgd-list [-h] [-f {csv,html,json,table,value,yaml}]
                          [-c COLUMN] [--max-width <integer>] [--noindent]
                          [--quote {all,minimal,none,nonnumeric}]
                          [--request-format {json,xml}] [-D] [-F FIELD]

List VNFFGDs that belong to a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker vnffgd-show¶

usage: tacker vnffgd-show [-h] [-f {html,json,shell,table,value,yaml}]
                          [-c COLUMN] [--max-width <integer>] [--noindent]
                          [--prefix PREFIX] [--request-format {json,xml}] [-D]
                          [-F FIELD]
                          VNFFGD

Show information of a given VNFFGD.

Positional arguments:

VNFFGD

ID or name of vnffgd to look up

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

tacker vnffgd-template-show¶

usage: tacker vnffgd-template-show [-h]
                                   [-f {html,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent] [--prefix PREFIX]
                                   [--request-format {json,xml}] [-D]
                                   [-F FIELD]
                                   VNFFGD

Show template of a given VNFFGD.

Positional arguments:

VNFFGD

ID or name of vnffgd to look up

Optional arguments:

-h, --help

show this help message and exit

--request-format {json,xml}

The xml or json request format

-D, --show-details

Show detailed info

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.