namemappings - Cygnus command

This command allows you to manage namemappings for Cygnus.

• List name mappings
• Create a name mapping
• Update a name mapping
• Delete a name mapping

Common Options

Options	Description
--host VALUE, -h VALUE	broker or server host VALUE (required)
--help	show help (default: true)

List name mappings

This command lists all name mappings.

ngsi namemappings [command options] list [options]

Options

Options	Description
--host VALUE, -h VALUE	broker or server host VALUE (required)
--pretty, -P	pretty format (default: false)
--help	show help (default: true)

Examples

Request:

ngsi namemappings list --pretty

{
  "success": "true",
  "result": {
    "serviceMappings": [
      {
        "originalService": "^(.*)",
        "newService": "null",
        "servicePathMappings": [
          {
            "originalServicePath": "/myservicepath1",
            "newServicePath": "/new_myservicepath1",
            "entityMappings": [
              {
                "originalEntityId": "myentityid1",
                "originalEntityType": "myentitytype1",
                "newEntityId": "new_myentityid1",
                "newEntityType": "new_myentitytype1",
                "attributeMappings": [
                  {
                    "originalAttributeName": "myattributename1",
                    "originalAttributeType": "myattributetype1",
                    "newAttributeName": "new_myattributename1",
                    "newAttributeType": "new_myattributetype1"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Create a name mapping

This command creates a name mapping.

ngsi namemapping [command options] create [options]

Options

Options	Description
--host VALUE, -h VALUE	broker or server host VALUE (required)
--data VALUE, -d VALUE	name mapping data (required)
--pretty, -P	pretty format (default: false)
--help	show help (default: true)

Examples

Request:

ngsi namemappings create -pretty \
--data '{
  "serviceMappings": [
    {
      "servicePathMappings": [
        {
          "originalServicePath": "/myservicepath1",
          "newServicePath": "/new_myservicepath1",
          "entityMappings": [
            {
              "originalEntityId": "myentityid1",
              "originalEntityType": "myentitytype1",
              "newEntityId": "new_myentityid1",
              "newEntityType": "new_myentitytype1",
              "attributeMappings": [
                {
                  "originalAttributeName": "myattributename1",
                  "originalAttributeType": "myattributetype1",
                  "newAttributeName": "new_myattributename1",
                  "newAttributeType": "new_myattributetype1"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}'

{
  "success": "true",
  "result": {
    "serviceMappings": [
      {
        "originalService": "^(.*)",
        "newService": "null",
        "servicePathMappings": [
          {
            "originalServicePath": "/myservicepath1",
            "newServicePath": "/new_myservicepath1",
            "entityMappings": [
              {
                "originalEntityId": "myentityid1",
                "originalEntityType": "myentitytype1",
                "newEntityId": "new_myentityid1",
                "newEntityType": "new_myentitytype1",
                "attributeMappings": [
                  {
                    "originalAttributeName": "myattributename1",
                    "originalAttributeType": "myattributetype1",
                    "newAttributeName": "new_myattributename1",
                    "newAttributeType": "new_myattributetype1"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Update a name mapping

This command updates a name mapping.

ngsi namemapping [command options] update [options]

Options

Options	Description
--host VALUE, -h VALUE	broker or server host VALUE (required)
--data VALUE, -d VALUE	name mapping data (required)
--pretty, -P	pretty format (default: false)
--help	show help (default: true)

Delete a name mapping

This command deletes a name mapping.

ngsi namemapping [command options] delete [options]

Options

Options	Description
--host VALUE, -h VALUE	broker or server host VALUE (required)
--data VALUE, -d VALUE	name mapping data (required)
--pretty, -P	pretty format (default: false)
--help	show help (default: true)

Examples

Request:

ngsi namemappings delete --pretty --data \
'{
  "serviceMappings": [
    {
      "originalService": "^(.*)",
      "newService": "null",
      "servicePathMappings": [
        {
          "originalServicePath": "/myservicepath1",
          "newServicePath": "/new_myservicepath1",
          "entityMappings": [
            {
              "originalEntityId": "myentityid1",
              "originalEntityType": "myentitytype1",
              "newEntityId": "new_myentityid1",
              "newEntityType": "new_myentitytype1",
              "attributeMappings": [
                {
                  "originalAttributeName": "myattributename1",
                  "originalAttributeType": "myattributetype1",
                  "newAttributeName": "new_myattributename1",
                  "newAttributeType": "new_myattributetype1"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}'

{
  "success": "true",
  "result": {
    "serviceMappings": [
      {
        "originalService": "^(.*)",
        "newService": "null",
        "servicePathMappings": [
          {
            "originalServicePath": "/myservicepath1",
            "newServicePath": "/new_myservicepath1",
            "entityMappings": [
              {
                "originalEntityId": "myentityid1",
                "originalEntityType": "myentitytype1",
                "newEntityId": "new_myentityid1",
                "newEntityType": "new_myentitytype1",
                "attributeMappings": []
              }
            ]
          }
        ]
      }
    ]
  }
}