MMI Managed Objects for SFAPP

MMI information associated with SFAPP is accessed from a DSR NOAM or SOAM from Main Menu > MMI API Guide.

Once the MMI API Guide displays, use the application navigation to locate specific vSTP managed object information.

Table 2-10 lists the managed objects and operations supported for vSTP SFAPP feature.

Table 2-10 vSTP SFAPP Managed Objects and Supported Operations

Managed Object Name	Supported Operations
SfappNeighboringCountries	Insert, Delete
VstpMateStp	Insert, Update, Delete
SfappCountryCodes	No operations supported
SfappCountrylongLati	No operations supported
SfappCCMCCMap	Insert, Delete
VstpSccpApplications	Insert, Update, Delete
VstpSccpOptions	Update

SfappNeighboringCountries - Insert, Delete

Execute the MMI Client command from an active SOAM.

 /vstp/SfappNeighboringCountries/ 
{
    "data": [
        {
            "mcc": 289,
            "name": "Abkhazia",
            "neighMcc": 250,
            "neighName": "Russia",
            "uniqueIdentifier": "289-250"
        },
…
        {
            "mcc": 648,
            "name": "Zimbabwe",
            "neighMcc": 655,
            "neighName": "South Africa",
            "uniqueIdentifier": "648-655"
        },
        {
            "mcc": 648,
            "name": "Zimbabwe",
            "neighMcc": 645,
            "neighName": "Zambia",
            "uniqueIdentifier": "648-645"
        }
    ],
    "links": {},
    "messages": [],
    "status": true
}

Execute this command on an active SOAM for Delete operation:

 /commonsecurity/neighboringcountries/<uniqueIdentifier> -v DELETE

Example output:

No output returned by URI: https://localhost/mmi/dsr/v3.1/commonsecurity/neighboringcountries/648-645? for 'DELETE' operation

VstpMateStp - Insert, Update, Delete

Example:

Execute this command on an active SOAM to display entries.

 /vstp/matestps/
{
   "data": [
       {
           "domain": "Itun",
           "pointCode": "13"
       }
   ],
   "links": {},
   "messages": [],
   "status": true
}

Create a file as follows for insert:

$cat matestp.json
{
    "domain": "Itun",
    "pointCode": "13"
}

Execute this command on an active SOAM to insert:

 /vstp/matestps/ -v POST -r <Absolute Path>/<filename>

Example output:

 /vstp/matestps/ -v POST -r matestp.json
{
    "data": true,
    "links": {},
    "messages": [],
    "status": true
}

Execute this command on an active SOAM to delete:

 /vstp/matestps/<pointCode> -v DELETE

Example output:

 /vstp/matestps/12 -v DELETE
No output returned by URI: https://localhost/mmi/dsr/v3.1/vstp/matestps/12? for 'DELETE' operation

SfappCCMCCMap - Insert, Delete

Execute the MMI Client command from an active SOAM.

 /commonsecurity/mappings/
{
    "data": [
        {
            "cc": 1,
            "mcc": 310,
            "ndc": 1,
            "uniqueIdentifier": "1-1"
        },
…
       {
            "cc": 998,
            "mcc": 434,
            "uniqueIdentifier": "998-0"
        }
    ],
    "links": {},
    "messages": [],
    "status": true
}

Execute the following command to display:

 /commonsecurity/mappings/<uniqueIdentifier>

Example output:

  /commonsecurity/mappings/"998-0"{
    "data": {
        "cc": 998,
        "mcc": 434,
        "uniqueIdentifier": "998-0"
    },
    "links": {
        "delete": {
            "action": "DELETE",
            "description": "Delete this item.",
            "href": "/mmi/dsr/v3.1/commonsecurity/mappings/998-0",
            "type": "status"
        },
        "update": {
            "action": "PUT",
            "description": "Update this item.",
            "href": "/mmi/dsr/v3.1/commonsecurity/mappings/998-0",
            "type": "status"
        }
    },
    "messages": [],
    "status": true
}
[root@fixsetup-soa1 ~]# cat mapping.json
        {
            "cc": 998,
            "mcc": 434
        }

Create a file as follows for insert:

cat mapping.json
        {
            "cc": 998,
            "mcc": 434
        }

Execute the following command to insert:

 /commonsecurity/mappings/ -v POST -r <Absolute Path>/<filename>

Example output:

 /commonsecurity/mappings/ -v POST -r mapping.json
{
    "data": true,
    "links": {},
    "messages": [],
    "status": true
}

Execute this command on an active SOAM to delete:

 /commonsecurity/mappings/<uniqueIdentifier> -v DELETE

Example output:

 /commonsecurity/mappings/"998-0" -v DELETENo output returned by URI: https://localhost/mmi/dsr/v3.1/vstp/gttactions/actid2006? for 'DELETE' operation

VstpSccpApplications - Insert, Update, Delete

Execute the MMI Client command from an active SOAM.

 /vstp/sccpapplications/
{
    "data": [
        {
            "appType": "Sfapp",
            "ssn": 67
        }
    ],
    "links": {},
    "messages": [],
    "status": true
}

Execute the following command to display:

 /vstp/sccpapplications/<appType>

 /vstp/sccpapplications/"Sfapp"
{
    "data": {
        "appType": "Sfapp",
        "ssn": 67
    },
    "links": {
        "delete": {
            "action": "DELETE",
            "description": "Delete this item.",
            "href": "/mmi/dsr/v3.1/vstp/sccpapplications/Sfapp",
            "type": "status"
        },
        "update": {
            "action": "PUT",
            "description": "Update this item.",
            "href": "/mmi/dsr/v3.1/vstp/sccpapplications/Sfapp",
            "type": "status"
        }
    },
    "messages": [],
    "status": true
}

Example output:

     "data": {
        "cc": 998,
        "mcc": 434,
        "uniqueIdentifier": "998-0"
    },
    "links": {
        "delete": {
            "action": "DELETE",
            "description": "Delete this item.",
            "href": "/mmi/dsr/v3.1/commonsecurity/mappings/998-0",
            "type": "status"
        },
        "update": {
            "action": "PUT",
            "description": "Update this item.",
            "href": "/mmi/dsr/v3.1/commonsecurity/mappings/998-0",
            "type": "status"
        }
    },
    "messages": [],
    "status": true
}
[root@fixsetup-soa1 ~]#
Insert
[root@fixsetup-soa1 ~]# cat mapping.json
        {
            "cc": 998,
            "mcc": 434
        }

Create a file as follows for insert:

 $cat sccpapplication.json
{
    "appType": "Sfapp",
    "ssn": 68
}

Execute the following command to insert:

 /vstp/sccpapplications/ -v POST -r <Absolute Path>/<filename>

Example:

 /vstp/sccpapplications/ -v POST -r sccpapplication.json
{
    "data": true,
    "links": {},
    "messages": [],
    "status": true
}

To update the file:

$cat  sccpapplication.json
{
    "appType": "Sfapp",
    "ssn": 69
}

Execute this command on an active SOAM to update:

 /vstp/sccpapplications/ -v PUT -r <Absolute Path>/<filename>

Example output:

 /vstp/sccpapplications/ -v PUT -r sccpapplication.json
{
    "data": true,
    "links": {},
    "messages": [],
    "status": true
}

Execute this command on an active SOAM to delete:

 /vstp/sccpapplications/<appType> -v DELETE

Example output:

 /vstp/sccpapplications/"Sfapp" -v DELETE
No output returned by URI: https://localhost/mmi/dsr/v3.1/vstp/sccpapplications/Sfapp? for 'DELETE' operation

VstpSCCPOptions- Update

Execute the MMI Client command from an active SOAM.

 /vstp/sccpoptions/
{
    "data": {
        "class1seq": "Disabled",
        "dfltfallback": false,
        "dfltgttmode": "Cd",
        "mtprgtt": "Off",
        "mtprgttfallback": "Mtproute",
        "tgtt0": "None",
        "tgtt1": "None",
        "tgttudtkey": "Mtp",
        "tgttxudtkey": "Mtp",
        "travelVelocity": 700
    },
    "links": {
        "update": {
            "action": "PUT",
            "description": "Update this item.",
            "href": "/mmi/dsr/v3.1/vstp/sccpoptions/",
            "type": "status"
        }
    },
    "messages": [],
    "status": true
}

Note:

The travelVelocity is an existing MO and a new parameter "travel_velocity" has been added as part of SFAPP feature.

Create a file as follows for update:

 $cat  sccpoption.json
{
    "class1seq":"Disabled",
    "dfltfallback": false,
    "dfltgttmode": "Fcd",
    "itun16ScmgEnabled":false,
    "tgtt0": "None",
    "tgtt1": "None",
    "tgttudtkey": "Mtp",
    "tgttxudtkey": "Mtp",
    "mtprgtt": "Usemtppc",
    "mtprgttfallback" "Gttfail",
    "travelVelocity": 650
}

Execute the following command to update:

 /vstp/sccpoptions/ -v PUT -r <Absolute Path>/<filename>

Example output:

 /vstp/sccpoptions/ -v PUT -r sccpoption.json
{
    "data": true,
    "links": {},
    "messages": [],
    "status": true
}

Example output:

 /vstp/sccpoptions/
{
    "data": {
        "class1seq": "Disabled",
        "dfltfallback": false,
        "dfltgttmode": "Fcd",
        "mtprgtt": "Usemtppc",
        "mtprgttfallback": "Gttfail",
        "tgtt0": "None",
        "tgtt1": "None",
        "tgttudtkey": "Mtp",
        "tgttxudtkey": "Mtp",
        "travelVelocity": 650
    },
    "links": {
        "update": {
            "action": "PUT",
            "description": "Update this item.",
            "href": "/mmi/dsr/v3.1/vstp/sccpoptions/",
            "type": "status"
        }
    },
    "messages": [],
    "status": true
}

SfappCountryCodes

There is no MMI support available for SfappCountryCodes, but a user can retrieve the data by executing get command on an active SOAM.

SfappCountrylongLati

There is no MMI support available for SfappCountrylongLati, but a user can retrieve the data using get command on an active SOAM.