NSX-T Data Center Global Manager REST API

Create or update IDS signature version site mapping on GM

Create or update IDS signature version site mapping on GM

Request:

Method:

PUT

URI Path(s):

/global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/site-version-mappings/{mapping-id}

Request Headers:

n/a

Query Parameters:

UpdateIdsSiteVersionMappingQueryParameters+

UpdateIdsSiteVersionMappingQueryParameters (schema)

Name	Description	Type	Notes
force	Force update Trigger an update for the IdsSiteVersionMapping even if there is no change in the IdsSiteVersionMapping. This is needed to recover from error conditions wherein the bundle download fails on the LM.	boolean	Default: "False"

Request Body:

IdsSiteVersionMapping+

IdsSiteVersionMapping (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
children	Subtree for this type within policy tree Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.	array of ChildPolicyConfigResource Children are not allowed for this type
custom_signature_version_paths	Custom signature version to be associated with this site Associate the provided site to this custom signature version. If this field is provided: 1. The management of the custom signatures can be done only from the global manager. 2. All the custom signatures that were already present on the local manager are deleted, and the custom signatures that are present on the global manager are pushed to the local manager. 3. Only the global manager GSM for the custom signatures is going to take effect. If this field was never populated, 1. The management of the custom signature will be done from the local manager. 2. Only the local manager GSM for the custom signatures are going to take effect. If field was earlier populated, and then updated to NULL, 1. The global manager can no more manage the custom signatures for the local manager. The management of the custom signature will be done from the local manager. 2. The signatures that were already pushed to the local manager stay on the local manager. 3. GSM for custom signatures that was pushed from global manager will be deleted from the local manager.	array of string	Maximum items: 1
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
effective_signature_version_path	Effective signature version for the site This readonly field provides which version is associated with the provided site. This flag is useful when the auto_update flag is true.	string	Readonly
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object get deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
origin_site_id	A unique identifier assigned by the system for knowing which site owns an object This is a UUID generated by the system for knowing which site owns an object.	string	Readonly
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified locally by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
owner_id	A unique identifier assigned by the system for the ownership of an object This is a UUID generated by the system for knowing who owns this object.	string	Readonly
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
realization_id	A unique identifier assigned by the system for realizing intent This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent.	string	Readonly
relative_path	Relative path of this object Path relative from its parent	string	Readonly
remote_path	Path of the object on the remote end. This path is populated only in case of multi-site scenario. Currently it is supported only for LM objects. When LM is onboarded to multi-site platform like NAPP or GM, remote_path will be set to the globally unique path across multi-site topology . It is generated based on local site-name and uses /org tree namespace. Note: It is populated only for LM objects. Not supported on the GM.	string	Readonly
resource_type	Must be set to the value IdsSiteVersionMapping	string
signature_version_path	Signature version path Associate the provided site to this signature version. To associate the provided site with the auto updated version on the GM, set this field to "AUTO_UPDATE".	string	Required
site_path	Site path Associate the provided signature version to this site.	string	Required
site_settings	Site specific settings This field holds the site specific settings such as syslog and oversubscription. If this field is not provided, LM setting take effect.	IdsSiteSettings
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

Example Request:

PUT https://<policy-mgr>/global-manager/api/v1/global-infra/settings/firewall/security/intrusion-services/site-version-mappings/london-v1-mapping

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IdsSiteVersionMapping+

IdsSiteVersionMapping (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
children	Subtree for this type within policy tree Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.	array of ChildPolicyConfigResource Children are not allowed for this type
custom_signature_version_paths	Custom signature version to be associated with this site Associate the provided site to this custom signature version. If this field is provided: 1. The management of the custom signatures can be done only from the global manager. 2. All the custom signatures that were already present on the local manager are deleted, and the custom signatures that are present on the global manager are pushed to the local manager. 3. Only the global manager GSM for the custom signatures is going to take effect. If this field was never populated, 1. The management of the custom signature will be done from the local manager. 2. Only the local manager GSM for the custom signatures are going to take effect. If field was earlier populated, and then updated to NULL, 1. The global manager can no more manage the custom signatures for the local manager. The management of the custom signature will be done from the local manager. 2. The signatures that were already pushed to the local manager stay on the local manager. 3. GSM for custom signatures that was pushed from global manager will be deleted from the local manager.	array of string	Maximum items: 1
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
effective_signature_version_path	Effective signature version for the site This readonly field provides which version is associated with the provided site. This flag is useful when the auto_update flag is true.	string	Readonly
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object get deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
origin_site_id	A unique identifier assigned by the system for knowing which site owns an object This is a UUID generated by the system for knowing which site owns an object.	string	Readonly
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified locally by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
owner_id	A unique identifier assigned by the system for the ownership of an object This is a UUID generated by the system for knowing who owns this object.	string	Readonly
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
realization_id	A unique identifier assigned by the system for realizing intent This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent.	string	Readonly
relative_path	Relative path of this object Path relative from its parent	string	Readonly
remote_path	Path of the object on the remote end. This path is populated only in case of multi-site scenario. Currently it is supported only for LM objects. When LM is onboarded to multi-site platform like NAPP or GM, remote_path will be set to the globally unique path across multi-site topology . It is generated based on local site-name and uses /org tree namespace. Note: It is populated only for LM objects. Not supported on the GM.	string	Readonly
resource_type	Must be set to the value IdsSiteVersionMapping	string
signature_version_path	Signature version path Associate the provided site to this signature version. To associate the provided site with the auto updated version on the GM, set this field to "AUTO_UPDATE".	string	Required
site_path	Site path Associate the provided signature version to this site.	string	Required
site_settings	Site specific settings This field holds the site specific settings such as syslog and oversubscription. If this field is not provided, LM setting take effect.	IdsSiteSettings
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

Example Response:

{ "site_path": "/global-infra/sites/London", "signature_version_path": "/global-infra/settings/firewall/security/intrusion-services/signature-versions/v1", "auto_update": false, "site_settings": { "ids_events_to_syslog": true, "oversubscription": "BYPASSED", "resource_type": "IdsSiteSettings" }, "resource_type": "IdsSiteVersionMapping", "id": "london-v1-mapping", "display_name": "London version1 site mapping" "_create_user": "system", "_create_time": 1559807855627, "_last_modified_user": "admin", "_last_modified_time": 1559810459486, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }

Required Permissions:

read

Feature:

policy_dfw_ids

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable