Get a particular service attachment.

Returns detailed Attachment information for a given service attachment.

Request:

Method:

GET

URI Path(s):

/api/v1/serviceinsertion/service-attachments/<service-attachment-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/serviceinsertion/service-attachments/01dfa028-bc90-4be4-bda1-a98b4eb65abc

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ServiceAttachment+

ServiceAttachment (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
attachment_status	Attachment Status UP - A Service Attachment will have its Service Port - UP and with a configured IP address. DOWN - An Inactive ServiceAttachment has its Service Port - DOWN. It can be used to connect set of appliances that do not need to exchange traffic to/from/through the Edge node.	string	Enum: UP, DOWN Default: "UP"
deployed_to	Deployed-to object NSX Resource where we want to create Service Attachment Point. Ex. T0 LR Edge in case of north-south ServiceInsertion and a TransportZone (which is used to define the service plane) in case of east-west service insertion.	ResourceReference	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
local_ips	Local IPs Local IPs associated with this Service Attachment.	array of IPInfo	Minimum items: 1 Maximum items: 1
logical_routers	Logical Router list List of LogicalRouters to be connected to the ServicePlane logical switch via a ServiceLink.	array of ResourceReference	Minimum items: 1 Maximum items: 128
logical_switch	Logical Switch Logical Switch gets created as a part of Service Attachment creation.	ResourceReference	Readonly
resource_type	Must be set to the value ServiceAttachment	string
service_port	Service Port (Logical Router Centralized Service Port) Service Port gets created as a part of Service Attachment creation. It is a Logical Router Port of type CentralizedServicePort. It does not participate in distributed routing. Stateless Policy Based Routing service can be applied on this port.	ResourceReference	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type": "ServiceAttachment", "id": "01dfa028-bc90-4be4-bda1-a98b4eb65abc", "display_name": "Service Attachment 1", "deployed_to": { "target_display_name": "T0_LR", "target_type": "LogicalRouter", "target_id": "d0ceab3f-866b-42d5-a67a-0eedbe604d35" }, "attachment_status": "UP", "logical_switch": { "target_display_name": "b7f69e2c-f42f-4fee-9313-c486b35a6d41", "is_valid": true, "target_type": "LogicalSwitch", "target_id": "b7f69e2c-f42f-4fee-9313-c486b35a6d41" }, "service_port": { "target_display_name": "aaa69e2c-vvvf-4fee-9313-c486b35a6ddd", "is_valid": true, "target_type": "LogicalRouterCentralizedServicePort", "target_id": "aaa69e2c-vvvf-4fee-9313-c486b35a6ddd" }, "local_ips": [ { "ip_addresses": [ "192.168.100.2" ], "prefix_length": 24 } ] }

Get a particular service attachment.

Request:

Example Request:

Successful Response:

ServiceAttachment (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: