Service Function Chaining is a mechanism for overriding the basic destination based forwarding that is typical of IP networks. Service Function Chains consist of an ordered sequence of Service Functions (SFs). SFs are virtual machines (or potentially physical devices) that perform a network function such as firewall, content cache, packet inspection, or any other function that requires processing of packets in a flow from point A to point B even though the SFs are not literally between point A and B from a routing table perspective.
Network v2
Create a flow classifier
openstack sfc flow classifier create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
[--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>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
--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.
name
¶Name of the flow classifier
This command is provided by the python-neutronclient plugin.
Delete a given flow classifier
openstack sfc flow classifier delete <flow-classifier>
flow-classifier
¶Flow classifier to delete (name or ID)
This command is provided by the python-neutronclient plugin.
List flow classifiers
openstack sfc flow classifier list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort-column SORT_COLUMN]
[--long]
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--quote
<QUOTE_MODE>
¶when to include quotes, defaults to nonnumeric
--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
--long
¶List additional fields in output
This command is provided by the python-neutronclient plugin.
Set flow classifier properties
openstack sfc flow classifier set
[--name <name>]
[--description <description>]
<flow-classifier>
--name
<name>
¶Name of the flow classifier
--description
<description>
¶Description for the flow classifier
flow-classifier
¶Flow classifier to modify (name or ID)
This command is provided by the python-neutronclient plugin.
Display flow classifier details
openstack sfc flow classifier show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
<flow-classifier>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
flow-classifier
¶Flow classifier to display (name or ID)
This command is provided by the python-neutronclient plugin.
Create a port chain
openstack sfc port chain create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
[--description <description>]
[--flow-classifier <flow-classifier>]
[--chain-parameters correlation=<correlation-type>,symmetric=<boolean>]
--port
-p
air-group
<port-pair-group>
<name>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
--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.
name
¶Name of the port chain
This command is provided by the python-neutronclient plugin.
Delete a given port chain
openstack sfc port chain delete <port-chain>
port-chain
¶Port chain to delete (name or ID)
This command is provided by the python-neutronclient plugin.
List port chains
openstack sfc port chain list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort-column SORT_COLUMN]
[--long]
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--quote
<QUOTE_MODE>
¶when to include quotes, defaults to nonnumeric
--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
--long
¶List additional fields in output
This command is provided by the python-neutronclient plugin.
Set port chain properties
openstack sfc port chain set
[--name <name>]
[--description <description>]
[--flow-classifier <flow-classifier>]
[--no-flow-classifier]
[--port-pair-group <port-pair-group>]
[--no-port-pair-group]
<port-chain>
--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 modify (name or ID)
This command is provided by the python-neutronclient plugin.
Display port chain details
openstack sfc port chain show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
<port-chain>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
port-chain
¶Port chain to display (name or ID)
This command is provided by the python-neutronclient plugin.
Unset port chain properties
openstack sfc port chain unset
[--flow-classifier <flow-classifier> | --all-flow-classifier]
[--port-pair-group <port-pair-group>]
<port-chain>
--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.
port-chain
¶Port chain to unset (name or ID)
This command is provided by the python-neutronclient plugin.
Create a port pair
openstack sfc port pair create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
[--description <description>]
[--service-function-parameters correlation=<correlation-type>,weight=<weight>]
--ingress <ingress>
--egress <egress>
<name>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
--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)
name
¶Name of the port pair
This command is provided by the python-neutronclient plugin.
Delete a given port pair
openstack sfc port pair delete <port-pair>
port-pair
¶Port pair to delete (name or ID)
This command is provided by the python-neutronclient plugin.
List port pairs
openstack sfc port pair list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort-column SORT_COLUMN]
[--long]
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--quote
<QUOTE_MODE>
¶when to include quotes, defaults to nonnumeric
--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
--long
¶List additional fields in output
This command is provided by the python-neutronclient plugin.
Set port pair properties
openstack sfc port pair set
[--name <name>]
[--description <description>]
<port-pair>
--name
<name>
¶Name of the port pair
--description
<description>
¶Description for the port pair
port-pair
¶Port pair to modify (name or ID)
This command is provided by the python-neutronclient plugin.
Display port pair details
openstack sfc port pair show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
<port-pair>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
port-pair
¶Port pair to display (name or ID)
This command is provided by the python-neutronclient plugin.
Create a port pair group
openstack sfc port pair group create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
[--description <description>]
[--port-pair <port-pair>]
[--enable-tap | --disable-tap]
[--port-pair-group-parameters lb-fields=<lb-fields>]
<name>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
--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.
name
¶Name of the port pair group
This command is provided by the python-neutronclient plugin.
Delete a given port pair group
openstack sfc port pair group delete <port-pair-group>
port-pair-group
¶Port pair group to delete (name or ID)
This command is provided by the python-neutronclient plugin.
List port pair group
openstack sfc port pair group list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort-column SORT_COLUMN]
[--long]
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--quote
<QUOTE_MODE>
¶when to include quotes, defaults to nonnumeric
--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
--long
¶List additional fields in output
This command is provided by the python-neutronclient plugin.
Set port pair group properties
openstack sfc port pair group set
[--name <name>]
[--description <description>]
[--port-pair <port-pair>]
[--no-port-pair]
<port-pair-group>
--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 modify (name or ID)
This command is provided by the python-neutronclient plugin.
Display port pair group details
openstack sfc port pair group show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
<port-pair-group>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
port-pair-group
¶Port pair group to display (name or ID)
This command is provided by the python-neutronclient plugin.
Unset port pairs from port pair group
openstack sfc port pair group unset
[--port-pair <port-pair> | --all-port-pair]
<port-pair-group>
--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
port-pair-group
¶Port pair group to unset (name or ID)
This command is provided by the python-neutronclient plugin.
Create a service graph.
openstack sfc service graph create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
[--description DESCRIPTION]
--branching
-p
oint
SRC_CHAIN:DST_CHAIN_1,DST_CHAIN_2,DST_CHAIN_N
<name>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
--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.
name
¶Name of the service graph.
This command is provided by the python-neutronclient plugin.
Delete a given service graph.
openstack sfc service graph delete <service-graph>
service-graph
¶ID or name of the service graph to delete.
This command is provided by the python-neutronclient plugin.
List service graphs
openstack sfc service graph list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort-column SORT_COLUMN]
[--long]
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--quote
<QUOTE_MODE>
¶when to include quotes, defaults to nonnumeric
--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
--long
¶List additional fields in output
This command is provided by the python-neutronclient plugin.
Set service graph properties
openstack sfc service graph set
[--name <name>]
[--description <description>]
<service-graph>
--name
<name>
¶Name of the service graph
--description
<description>
¶Description for the service graph
service-graph
¶Service graph to modify (name or ID)
This command is provided by the python-neutronclient plugin.
Show information of a given service graph.
openstack sfc service graph show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--noindent]
[--prefix PREFIX]
<service-graph>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated
--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.
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
service-graph
¶ID or name of the service graph to display.
This command is provided by the python-neutronclient plugin.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.