Chapter 74. sfc

This chapter describes the commands under the sfc command.

74.1. sfc flow classifier create

Create a flow classifier

Usage:

openstack sfc flow classifier create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--description <description>]
                                            [--protocol <protocol>]
                                            [--ethertype {IPv4,IPv6}]
                                            [--source-port <min-port>:<max-port>]
                                            [--destination-port <min-port>:<max-port>]
                                            [--source-ip-prefix <source-ip-prefix>]
                                            [--destination-ip-prefix <destination-ip-prefix>]
                                            [--logical-source-port <logical-source-port>]
                                            [--logical-destination-port <logical-destination-port>]
                                            [--l7-parameters L7_PARAMETERS]
                                            <name>

Table 74.1. Positional Arguments

ValueSummary

<name>

Name of the flow classifier

Table 74.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description for the flow classifier

--protocol <protocol>

Ip protocol name. protocol name should be as per iana standard.

--ethertype {IPv4,IPv6}

L2 ethertype, default is ipv4

--source-port <min-port>:<max-port>

Source protocol port (allowed range [1,65535]. must be specified as a:b, where a=min-port and b=max-port) in the allowed range.

--destination-port <min-port>:<max-port>

Destination protocol port (allowed range [1,65535]. Must be specified as a:b, where a=min-port and b=max- port) in the allowed range.

--source-ip-prefix <source-ip-prefix>

Source ip address in cidr notation

--destination-ip-prefix <destination-ip-prefix>

Destination ip address in cidr notation

--logical-source-port <logical-source-port>

Neutron source port (name or id)

--logical-destination-port <logical-destination-port>

Neutron destination port (name or id)

--l7-parameters L7_PARAMETERS

Dictionary of l7 parameters. currently, no value is supported for this option.

Table 74.3. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.5. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.6. Table Formatter

ValueSummary

--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.

74.2. sfc flow classifier delete

Delete a given flow classifier

Usage:

openstack sfc flow classifier delete [-h] <flow-classifier>

Table 74.7. Positional Arguments

ValueSummary

<flow-classifier>

Flow classifier to delete (name or id)

Table 74.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

74.3. sfc flow classifier list

List flow classifiers

Usage:

openstack sfc flow classifier list [-h]
                                          [-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] [--long]

Table 74.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 74.10. Output Formatters

ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--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

Table 74.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 74.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.13. Table Formatter

ValueSummary

--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.

74.4. sfc flow classifier set

Set flow classifier properties

Usage:

openstack sfc flow classifier set [-h] [--name <name>]
                                         [--description <description>]
                                         <flow-classifier>

Table 74.14. Positional Arguments

ValueSummary

<flow-classifier>

Flow classifier to modify (name or id)

Table 74.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of the flow classifier

--description <description>

Description for the flow classifier

74.5. sfc flow classifier show

Display flow classifier details

Usage:

openstack sfc flow classifier show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <flow-classifier>

Table 74.16. Positional Arguments

ValueSummary

<flow-classifier>

Flow classifier to display (name or id)

Table 74.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 74.18. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.20. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.21. Table Formatter

ValueSummary

--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.

74.6. sfc port chain create

Create a port chain

Usage:

openstack sfc port chain create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       [--description <description>]
                                       [--flow-classifier <flow-classifier>]
                                       [--chain-parameters correlation=<correlation-type>,symmetric=<boolean>]
                                       --port-pair-group <port-pair-group>
                                       <name>

Table 74.22. Positional Arguments

ValueSummary

<name>

Name of the port chain

Table 74.23. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description for the port chain

--flow-classifier <flow-classifier>

Add flow classifier (name or id). this option can be repeated.

--chain-parameters correlation=<correlation-type>,symmetric=<boolean>

Dictionary of chain parameters. supports correlation=(mpls

nsh) (default is mpls) and symmetric=(true

false).

--port-pair-group <port-pair-group>

Add port pair group (name or id). this option can be repeated.

Table 74.24. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.25. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.26. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.27. Table Formatter

ValueSummary

--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.

74.7. sfc port chain delete

Delete a given port chain

Usage:

openstack sfc port chain delete [-h] <port-chain>

Table 74.28. Positional Arguments

ValueSummary

<port-chain>

Port chain to delete (name or id)

Table 74.29. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

74.8. sfc port chain list

List port chains

Usage:

openstack sfc port chain list [-h] [-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] [--long]

Table 74.30. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 74.31. Output Formatters

ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--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

Table 74.32. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 74.33. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.34. Table Formatter

ValueSummary

--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.

74.9. sfc port chain set

Set port chain properties

Usage:

openstack sfc port chain set [-h] [--name <name>]
                                    [--description <description>]
                                    [--flow-classifier <flow-classifier>]
                                    [--no-flow-classifier]
                                    [--port-pair-group <port-pair-group>]
                                    [--no-port-pair-group]
                                    <port-chain>

Table 74.35. Positional Arguments

ValueSummary

<port-chain>

Port chain to modify (name or id)

Table 74.36. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of the port chain

--description <description>

Description for the port chain

--flow-classifier <flow-classifier>

Add flow classifier (name or id). this option can be repeated.

--no-flow-classifier

Remove associated flow classifiers from the port chain

--port-pair-group <port-pair-group>

Add port pair group (name or id). current port pair groups order is kept, the added port pair group will be placed at the end of the port chain. This option can be repeated.

--no-port-pair-group

Remove associated port pair groups from the port chain. At least one --port-pair-group must be specified together.

74.10. sfc port chain show

Display port chain details

Usage:

openstack sfc port chain show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <port-chain>

Table 74.37. Positional Arguments

ValueSummary

<port-chain>

Port chain to display (name or id)

Table 74.38. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 74.39. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.40. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.41. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.42. Table Formatter

ValueSummary

--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.

74.11. sfc port chain unset

Unset port chain properties

Usage:

openstack sfc port chain unset [-h]
                                      [--flow-classifier <flow-classifier> | --all-flow-classifier]
                                      [--port-pair-group <port-pair-group>]
                                      <port-chain>

Table 74.43. Positional Arguments

ValueSummary

<port-chain>

Port chain to unset (name or id)

Table 74.44. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--flow-classifier <flow-classifier>

Remove flow classifier(s) from the port chain (name or ID). This option can be repeated.

--all-flow-classifier

Remove all flow classifiers from the port chain

--port-pair-group <port-pair-group>

Remove port pair group(s) from the port chain (name or ID). This option can be repeated.

74.12. sfc port pair create

Create a port pair

Usage:

openstack sfc port pair create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      [--description <description>]
                                      [--service-function-parameters correlation=<correlation-type>,weight=<weight>]
                                      --ingress <ingress> --egress <egress>
                                      <name>

Table 74.45. Positional Arguments

ValueSummary

<name>

Name of the port pair

Table 74.46. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description for the port pair

--service-function-parameters correlation=<correlation-type>,weight=<weight>

Dictionary of service function parameters. currently, correlation=(None

mpls

nsh) and weight are supported. Weight is an integer that influences the selection of a port pair within a port pair group for a flow. The higher the weight, the more flows will hash to the port pair. The default weight is 1.

--ingress <ingress>

Ingress neutron port (name or id)

--egress <egress>

Egress neutron port (name or id)

Table 74.47. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.48. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.49. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.50. Table Formatter

ValueSummary

--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.

74.13. sfc port pair delete

Delete a given port pair

Usage:

openstack sfc port pair delete [-h] <port-pair>

Table 74.51. Positional Arguments

ValueSummary

<port-pair>

Port pair to delete (name or id)

Table 74.52. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

74.14. sfc port pair group create

Create a port pair group

Usage:

openstack sfc port pair group create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--description <description>]
                                            [--port-pair <port-pair>]
                                            [--enable-tap | --disable-tap]
                                            [--port-pair-group-parameters lb-fields=<lb-fields>]
                                            <name>

Table 74.53. Positional Arguments

ValueSummary

<name>

Name of the port pair group

Table 74.54. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description for the port pair group

--port-pair <port-pair>

Port pair (name or id). this option can be repeated.

--enable-tap

Port pairs of this port pair group are deployed as passive tap service function

--disable-tap

Port pairs of this port pair group are deployed as l3 service function (default)

--port-pair-group-parameters lb-fields=<lb-fields>

Dictionary of port pair group parameters. currently only one parameter lb-fields is supported. <lb-fields> is a & separated list of load-balancing fields.

Table 74.55. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.56. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.57. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.58. Table Formatter

ValueSummary

--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.

74.15. sfc port pair group delete

Delete a given port pair group

Usage:

openstack sfc port pair group delete [-h] <port-pair-group>

Table 74.59. Positional Arguments

ValueSummary

<port-pair-group>

Port pair group to delete (name or id)

Table 74.60. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

74.16. sfc port pair group list

List port pair group

Usage:

openstack sfc port pair group list [-h]
                                          [-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] [--long]

Table 74.61. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 74.62. Output Formatters

ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--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

Table 74.63. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 74.64. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.65. Table Formatter

ValueSummary

--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.

74.17. sfc port pair group set

Set port pair group properties

Usage:

openstack sfc port pair group set [-h] [--name <name>]
                                         [--description <description>]
                                         [--port-pair <port-pair>]
                                         [--no-port-pair]
                                         <port-pair-group>

Table 74.66. Positional Arguments

ValueSummary

<port-pair-group>

Port pair group to modify (name or id)

Table 74.67. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of the port pair group

--description <description>

Description for the port pair group

--port-pair <port-pair>

Port pair (name or id). this option can be repeated.

--no-port-pair

Remove all port pair from port pair group

74.18. sfc port pair group show

Display port pair group details

Usage:

openstack sfc port pair group show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <port-pair-group>

Table 74.68. Positional Arguments

ValueSummary

<port-pair-group>

Port pair group to display (name or id)

Table 74.69. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 74.70. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.71. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.72. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.73. Table Formatter

ValueSummary

--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.

74.19. sfc port pair group unset

Unset port pairs from port pair group

Usage:

openstack sfc port pair group unset [-h]
                                           [--port-pair <port-pair> | --all-port-pair]
                                           <port-pair-group>

Table 74.74. Positional Arguments

ValueSummary

<port-pair-group>

Port pair group to unset (name or id)

Table 74.75. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--port-pair <port-pair>

Remove port pair(s) from the port pair group (name or ID). This option can be repeated.

--all-port-pair

Remove all port pairs from the port pair group

74.20. sfc port pair list

List port pairs

Usage:

openstack sfc port pair list [-h] [-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] [--long]

Table 74.76. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 74.77. Output Formatters

ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--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

Table 74.78. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 74.79. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.80. Table Formatter

ValueSummary

--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.

74.21. sfc port pair set

Set port pair properties

Usage:

openstack sfc port pair set [-h] [--name <name>]
                                   [--description <description>]
                                   <port-pair>

Table 74.81. Positional Arguments

ValueSummary

<port-pair>

Port pair to modify (name or id)

Table 74.82. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of the port pair

--description <description>

Description for the port pair

74.22. sfc port pair show

Display port pair details

Usage:

openstack sfc port pair show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <port-pair>

Table 74.83. Positional Arguments

ValueSummary

<port-pair>

Port pair to display (name or id)

Table 74.84. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 74.85. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.86. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.87. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.88. Table Formatter

ValueSummary

--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.

74.23. sfc service graph create

Create a service graph.

Usage:

openstack sfc service graph create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--description DESCRIPTION]
                                          --branching-point
                                          SRC_CHAIN:DST_CHAIN_1,DST_CHAIN_2,DST_CHAIN_N
                                          <name>

Table 74.89. Positional Arguments

ValueSummary

<name>

Name of the service graph.

Table 74.90. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description DESCRIPTION

Description for the service graph.

--branching-point SRC_CHAIN:DST_CHAIN_1,DST_CHAIN_2,DST_CHAIN_N

Service graph branching point: the key is the source Port Chain while the value is a list of destination Port Chains. This option can be repeated.

Table 74.91. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.92. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.93. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.94. Table Formatter

ValueSummary

--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.

74.24. sfc service graph delete

Delete a given service graph.

Usage:

openstack sfc service graph delete [-h] <service-graph>

Table 74.95. Positional Arguments

ValueSummary

<service-graph>

Id or name of the service graph to delete.

Table 74.96. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

74.25. sfc service graph list

List service graphs

Usage:

openstack sfc service graph list [-h] [-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] [--long]

Table 74.97. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 74.98. Output Formatters

ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--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

Table 74.99. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 74.100. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.101. Table Formatter

ValueSummary

--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.

74.26. sfc service graph set

Set service graph properties

Usage:

openstack sfc service graph set [-h] [--name <name>]
                                       [--description <description>]
                                       <service-graph>

Table 74.102. Positional Arguments

ValueSummary

<service-graph>

Service graph to modify (name or id)

Table 74.103. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of the service graph

--description <description>

Description for the service graph

74.27. sfc service graph show

Show information of a given service graph.

Usage:

openstack sfc service graph show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <service-graph>

Table 74.104. Positional Arguments

ValueSummary

<service-graph>

Id or name of the service graph to display.

Table 74.105. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 74.106. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.107. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.108. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.109. Table Formatter

ValueSummary

--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.