apps sip-whitelist
Required Command-Line Mode = Configure
Use the apps sip-whitelist command to configure SIP forward listing.
The apps sip-whitelistcommand has the following syntax:
apps sip-whitelist alias <SIP whitelist file alias>
add callerid <caller/callee ID>
add id-range <id-range>
add ip-addr <ip-address>
create
delete <all | callerid <caller ID>>
destroy
fetch <add | delete> <URL for a SIP whitelist file>
The following table describes the arguments for the apps sip-whitelist command:
Argument |
Description |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sip-whitelist alias <SIP whitelist file alias> |
Specifies an alias of the forward list file. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add callerid <caller ID> |
Adds a single caller ID entry to a forward list. Specify up to 64 alphanumeric characters. The supported characters include:
For example: (config) # apps sip-whitelist alias sip-scp add callerid 302701237777777 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add id-range <id-range> |
Adds the range of caller-ids to the forward list entries from the given start range to the end range . The start and the end range must contain a maximum of 64 numeric characters. The supported characters include:
For example: (config) # apps sip-whitelist alias sip-scp add id-range 123456700..123456750 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
add ip-addr <ip-address> |
Adds a valid IPv4/IPv6 address to the forward list entries. IP address must be a valid single:
For example: (config) # apps sip-whitelist alias sip-scp add ip-addr 192.168.1.1 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
create |
Creates a new forward list. For example: (config) # apps sip-whitelist alias sip-scp create To create a forward list, refer to How to Create a Forward List. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
delete <all | callerid <caller ID>> |
Specifies actions for delete as follows:
When using delete all to delete a forward list, unlike destroy, you do not have to delete the forward list maps, the GigaSMART operation, or disassociate the GigaSMART group from the forward list. Examples: (config) # apps sip-whitelist alias sip-scp delete callerid 302701237777777 (config) # apps sip-whitelist alias sip-scp delete all |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
destroy |
Destroys a forward list. For example: (config) # apps sip-whitelist alias sip-scp destroy When using destroy to delete a forward list, unlike delete all, you must first delete the forward list maps, the GigaSMART operation, and disassociate the GigaSMART group from the forward list before deleting the forward list. For the procedure to destroy the forward list, refer to How to Destroy a Forward List. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fetch <add | delete> <URL for a SIP whitelist file> |
Specifies actions for fetch as follows:
To fetch a specified forward list file from a location, use one of the following formats:
For SIP forward listing in a cluster, only fetch the forward list to the leader in the cluster. On member nodes, fetch is not available. Examples: (config) # apps sip-whitelist alias sip-scp fetch add http://1.1.1.1/tftp/temp/MyIDs1.txt (config) # apps sip-whitelist alias sip-scp2 fetch add scp://user1:mypw@1.1.1.1:/home/temp/C_ID_file1.txt (config) # apps sip-whitelist alias sip-scp fetch delete http://1.1.1.1/tftp/temp/MyIDstoDelete.txt (config) # apps sip-whitelist alias sip-scp2 fetch delete scp://user1:mypw@1.1.1.1:/home/temp/C_ID_delfile.txt |
How to Create a Forward List
To create a forward list, use the following CLI command sequence:
Task |
Command |
Create the forward list. |
(config) # apps sip-whitelist alias sip-scp create |
Associate the GigaSMART group to the forward list. |
(config) # gsparams gsgroup gsg1 sip-whitelist add sip-scp |
Configure the GigaSMART operation. |
(config) # gsop alias sip_wl1 flow-ops sip-whitelist lb app sip metric hashing key caller-id port-list gsg1 |
Add single entries to the whitelist.orFetch and download forward list files. |
(config) # apps sip-whitelist alias sip-scp1 add callerid 302701237777777 (config) # apps sip-whitelist alias sip-scp1 add callerid 302701237777778 (config) # apps sip-whitelist alias sip-scp1 fetch add http://1.1.1.1/tftp/temp/whitelist1.txt (config) # apps sip-whitelist alias sip-scp1 fetch add http://1.1.1.1/tftp/temp/whitelist2.txt |
Create a second level map, the forward list map. When the map configuration is complete, the forward list will take effect. Note: The SIP forward list map does not have any rules. |
(config) # map alias SIP-WL-S11 (config map alias SIP-WL-S11) # type secondLevel flowWhitelist-sip (config map alias SIP-WL-S11) # from vp1 (config map alias SIP-WL-S11) # use gsop sip_wl1 (config map alias SIP-WL-S11) # to pg-wl-1 (config map alias SIP-WL-S11) # exit (config) # |
How to Destroy a Forward List
To destroy the entire forward list, use the following CLI command sequence:
Task |
Command |
Delete a forward list map. |
(config) # no map alias SIP-WL-S11 |
Delete the GigaSMART operation. |
(config) # no gsop alias sip_wl1 |
Disassociate the GigaSMART group from the forward list. (You do not need to delete the gsgroup.) |
(config) # gsparams gsgroup gsg1 sip-whitelist delete |
Destroy () the entire forward list. |
(config) # apps sip-whitelist alias sip-scp1 destroy |
Related Commands
The following table summarizes other commands related to the apps sip-whitelist command:
Task |
Command |
Displays a particular caller ID associated with the GigaSMART group. |
# show gsgroup sip-whitelist alias gsg1 caller-id 302701237777777 |
Displays the SIP forward list entry count. |
# show apps sip-whitelist alias sip-scp count |