Chapter 74. sfc

<name>

Name of the flow classifier

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

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

<flow-classifier>

Flow classifier to delete (name or id)

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--long

List additional fields in output

-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 to show multiple columns

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

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

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.

<flow-classifier>

Flow classifier to modify (name or id)

-h, --help

Show this help message and exit

--name <name>

Name of the flow classifier

--description <description>

Description for the flow classifier

<flow-classifier>

Flow classifier to display (name or id)

-h, --help

Show this help message and exit

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

Name of the port chain

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

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

<port-chain>

Port chain to delete (name or id)

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--long

List additional fields in output

-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 to show multiple columns

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

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

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.

<port-chain>

Port chain to modify (name or id)

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

<port-chain>

Port chain to display (name or id)

-h, --help

Show this help message and exit

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

<port-chain>

Port chain to unset (name or id)

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

<name>

Name of the port pair

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

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

<port-pair>

Port pair to delete (name or id)

-h, --help

Show this help message and exit

<name>

Name of the port pair group

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

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

<port-pair-group>

Port pair group to delete (name or id)

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--long

List additional fields in output

-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 to show multiple columns

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

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

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.

<port-pair-group>

Port pair group to modify (name or id)

-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

<port-pair-group>

Port pair group to display (name or id)

-h, --help

Show this help message and exit

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

<port-pair-group>

Port pair group to unset (name or id)

-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

-h, --help

Show this help message and exit

--long

List additional fields in output

-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 to show multiple columns

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

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

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.

<port-pair>

Port pair to modify (name or id)

-h, --help

Show this help message and exit

--name <name>

Name of the port pair

--description <description>

Description for the port pair

<port-pair>

Port pair to display (name or id)

-h, --help

Show this help message and exit

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

Name of the service graph.

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

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

<service-graph>

Id or name of the service graph to delete.

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--long

List additional fields in output

-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 to show multiple columns

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

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

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.

<service-graph>

Service graph to modify (name or id)

-h, --help

Show this help message and exit

--name <name>

Name of the service graph

--description <description>

Description for the service graph

<service-graph>

Id or name of the service graph to display.

-h, --help

Show this help message and exit

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