Deleting an SMS gateway
Use the smsgw_delete command to delete an SMS gateway.
smsgw_delete smsgw=SMSGatewayName [ internal=<yes|no> ]Parameters
| Name | Type | Description | Mandatory | Default |
|---|---|---|---|---|
| smsgw | Object name | SMS gateway to be deleted. | Y | N/A |
| internal | Boolean | Specifies that the gateway is an internal gateway. | N | no |
A gateway cannot be deleted if it is part of a notification rule or if it is being used by a destination.
It is impossible to delete an SMS gateway while there are uncleared alerting events.
Example:
smsgw_delete smsgw=external-SMSGW
Output:
Command completed successfully.Access control
| User Category | Permission |
|---|---|
| Storage administrator | Allowed |
| Application administrator | Disallowed |
| Security administrator | Disallowed |
| Read-only users | Disallowed |
| Operations administrator | Allowed |
| Host side accelerator client | Disallowed |
Warnings
- ARE_YOU_SURE_YOU_WANT_TO_DELETE_SMS_GATEWAY
Are you sure you want to delete SMS gateway Gateway?
Return codes
- CANNOT_CHANGE_EVENT_CONF_WITH_ALERTING_EVENTS
Cannot change event configuration while there are alerting events.
Troubleshooting: Clear all alerting events before changing event configuration.
- GATEWAY_NAME_DOES_NOT_EXIST
Gateway name does not exist.
- GATEWAY_USED_BY_DESTINATION
Gateway is used by a destination.