Performs operations on rule objects.
Service | ruleobject |
Permission | Object XML API |
Version | set, delete - 4.4.9 or later list - 4.4.9-P2 or later object-api-restricted - 4.6.3 (52890) or later |
object-name — Name of the rule object to modify.
action — One of set, delete, and list. If set is used, the value-append, value-delete or value-set must be defined.
set — Creates the object if it does not exist or manipulates an existing object. When choosing the set action, in case rule-object does not exist, then the action-type should be selected.
object-type — String (Mandatory). The rule object type. common values: STATEMENT, ip, object (provide one of value-set, value-append, and value-delete).
value-set — Sets values for the rule object. If the rule object does not exist, it gets created.
object-description - Optional description.
value-append - Appends the specified values to the rule object. Multiple values may be specified in a comma-separated list.
value-delete - Delete all specified values from the rule object. Multiple values may be specified in a comma-separated list.
object-api-restricted - true or false (default = false). Mandatory when creating new rule object which is API restricted (manipulated only via XML API).
db-ids — Mandatory. The list of database IDs (DAM). Multiple values may be specified in a comma-separated list, for example, db-ids=10200000,10201000.
value-set, value-append, or value-delete — Mandatory, provide group of values.
object-default-value — Alternative or default value for the case of missing mapping otherwise rule is ignored.
— Optional only on value-set. Multiple values may be specified in a comma-separated list (for example, object-default-value=Windows, Linux, Mac).
— in order to reset value provide empty value (object-default-value=).
Note
Interaction with such an API restricted object involve providing mapping of keys (via parameter: db-ids) and values (via parameters: value-set/value-append/value-delete). Therefore, order is important and also the number of db-ids should be equal to number of groups of values. Keep your values non-empty for the set operation to reset values. You may use a pair of brackets ().
For example, the parameter line:
db-ids=12600000,12601000&value-set=(WIN,LINUX)(MAC1,MAC2)is actually mapping 12600000 => WIN,LINUX and 12601000 => MAC1,MAC2
Group of values — The collection of multiple elements, each one is surrounded with special brackets: [(' , ')] whereas each element is constructed from multiple non-empty values specified as comma-separated list.
Format: [(V1,V2,...Vn)][(W1,W2,...Wm)]
Examples
(WIN1)][(WIN2)] - Two groups of one element each
[(WIN1,WIN2,WIN3)][(WIN1)][(WIN2)]
Examples for rule object
Note
Only one value action (append, set or delete) is allowed per a single request
List the rule object:
https://127.0.0.1:8443/xmlapi.svc?service=ruleobject&action=listFind a rule object:
https://127.0.0.1:8443/xmlapi.svc?service=ruleobject&object-name=nameOfRuleObjectAdd a new rule object with a value list (1.1.1.1,1.1.2.2), type (ip) and a description ('Block List IPs'), issue the request:
https://127.0.0.1:8443/xmlapi.svc?service=ruleobject&action=set&object-name=blocklist_ip&value-set=1.1.1.1,1.1.2.2&object-type=ip&object-description=Block%20List%20IPsDelete a specific value (1.1.2.2) from a rule object:
https://127.0.0.1:8443/xmlapi.svc?service=ruleobject&action=set&object-name=blocklist_ip&value-delete=1.1.2.2Delete completely a rule object use:
https://127.0.0.1:8443/xmlapi.svc?service=ruleobject&action=delete&object-name=blocklist_ip
Examples for API restricted
Create a simple API restricted rule object:
https://127.0.0.1:8443/xmlapi.svc?service=ruleobject&action=set&object-type=STATEMENT&object-name=name&object-api-restricted=true&db-ids=12600000&value-set=[(val1)]Create an API restricted rule object with a default value, which behaves like map between 3 databases to single value each:
https://127.0.0.1:8443/xmlapi.svc?service=ruleobject&action=set&object-type=STATEMENT&object-name=name&object-api-restricted=true&db-ids=12600000,12601000,12602000&value-set=[(val1)][(val2)][(val3)]&object-default-value=d1Delete values from API restricted rule object:
https://127.0.0.1:8443/xmlapi.svc?service=ruleobject&action=set&object-name=name&db-ids=12600000,12601000,12602000&value-delete=[(val1)][(val2)][(val3)]Append values for API restricted rule object:
https://127.0.0.1:8443/xmlapi.svc?service=ruleobject&action=set&object-name=name&db-ids=12600000,12601000,12602000&value-append=[(val0,val1)][(val0,val2)][(val0,val3)]Set values for db-ids and reset values for specific db-id:
https://127.0.0.1:8443/xmlapi.svc?service=ruleobject&action=set&object-name=name&object-type=STATEMENT&db-ids=12600000,12601000,12602000&value-set=[(val0,val1)][(val0,val2)][()]