PEM::ServiceChainEndpoint¶
Introduced : BIG-IP_v11.4.0
You can use the service chain endpoint component to configure service
chain endpoint definitions for the Policy Enforcement Manager (PEM).
Each service chain endpoint consists of one or more service endpoints,
where a service endpoint consists of a non-zero integer order, a valid
PEM forwarding-endpoint (to-endpoint) and an existing vlan
(from-vlan). When you configure a BIG-IP that has a service chain
endpoint with multiple service endpoints, then the traffic will pass
through these service endpoints in their given order (from low to
high) before leaving the BIG-IP. Note: You must create a valid
forwarding-endpoint and a valid vlan before you can create a service
endpoint. You must also give each service endpoint an order from 1 up
to 2^32-1.
Methods¶
| Method | Description | Introduced |
| add_service_endpoint | Adds a set of service endpoints for the specified service chain endpoints. The orders need to be unique upon creation. An error is reported if two service endpoints are configured with the same order. | BIG-IP_v11.4.0 |
| create | Creates a set of PEM service chain endpoints. | BIG-IP_v11.4.0 |
| delete_all_service_chain_endpoints | Deletes all user defined service chain endpoints. | BIG-IP_v11.4.0 |
| delete_service_chain_endpoint | Deletes the specified service chain endpoints. | BIG-IP_v11.4.0 |
| get_list | Gets a list of all service chain endpoints. | BIG-IP_v11.4.0 |
| get_service_endpoint | Gets a set of service endpoints for the specified service chain endpoints. | BIG-IP_v11.4.0 |
| get_service_endpoint_from_vlan | Gets the from-vlans for the specified service endpoints. | BIG-IP_v11.4.0 |
| get_service_endpoint_internal_virtual_server | Gets the internal virtual servers for the specified service endpoints. | BIG-IP_v11.5.0 |
| get_service_endpoint_option_type | Gets the service option types for the specified service endpoints. | BIG-IP_v11.4.0 |
| get_service_endpoint_order | Gets the orders for the specified service endpoints. | BIG-IP_v11.4.0 |
| get_service_endpoint_steering_policy | Gets the steering policies for the specified service endpoints. | BIG-IP_v11.5.0 |
| get_service_endpoint_to_endpoint | Gets the to-endpoints for the specified service endpoints. | BIG-IP_v11.4.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v11.4.0 |
| remove_all_service_endpoints | Removes all service endpoints for the specified service chain endpoints. | BIG-IP_v11.4.0 |
| remove_service_endpoint | Removes the specified service endpoints for the specified service chain endpoints. | BIG-IP_v11.4.0 |
| set_service_endpoint_from_vlan | Sets the from-vlans for the specified service endpoints. A from-vlan specifies the vlan that the traffic comes from. Note: The vlan has to exist before you can set a from-vlan field. | BIG-IP_v11.4.0 |
| set_service_endpoint_internal_virtual_server | Sets the internal virtual servers for the specified service endpoints. Specifies the internal virtual server attribute on which icap profile is enabled. If the action is to forward to icap then the flow is forwarded to the pool members in the virtual server. | BIG-IP_v11.5.0 |
| set_service_endpoint_option_type | Sets the service option types for the specified service endpoints when a service endpoint is not available (i.e., is down). You can configure the following options: optional and mandatory. The default value is optional. | BIG-IP_v11.4.0 |
| set_service_endpoint_order | Sets the orders for the specified service endpoints. A service endpoint must have an order from 1 up to 2^32-1. The lower the service endpoint order is, the higher its precedence is (i.e., traffic will pass though it before other higher order service endpoints). | BIG-IP_v11.4.0 |
| set_service_endpoint_steering_policy | Sets the steering policies for the specified service endpoints. Specifies the steering policy for the service endpoint. This refers to the existing object pem policy. If the policy rule matches, the actions are applied on the intermediate flows in the service chain. The forwarding action in the steering policy can overwrite any default forwarding action configured in the service endpoint. The service chain action in a steering policy is not allowed. | BIG-IP_v11.5.0 |
| set_service_endpoint_to_endpoint | Sets the to-endpoints for the specified service endpoints. A to-endpoint is the actual forwarding-endpoint that the traffic goes to. Note: You have to create a valid PEM forwarding-endpoint before you can add to-endpoint to a service endpoint. | BIG-IP_v11.4.0 |
Enumerations¶
| Enumeration | Description |
| ServiceOptionType | Specifies the behavior when a service endpoint is not available (i.e., is down). You can configure the following options: optional and mandatory. |
Aliases¶
| Alias | Type | Description |
| ServiceOptionTypeSequence | ServiceOptionType [] | A sequence of service option types. |
| ServiceOptionTypeSequenceSequence | ServiceOptionType [] [] | A sequence of sequence of service option types. |
See Also¶
iControl ::
Warning
The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.
Sample Code¶
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.