python commands
configure
— python
— apply-groups reference
— apply-groups-exclude reference
— python-policy string
— apply-groups reference
— apply-groups-exclude reference
— cache
— admin-state keyword
— apply-groups reference
— apply-groups-exclude reference
— entry-size number
— max-entries number
— max-entry-lifetime number
— mcs-peer
— apply-groups reference
— apply-groups-exclude reference
— ip-address reference
— sync-tag string
— minimum-lifetimes
— high-availability number
— multi-chassis-redundancy number
— persistence number
— persistence boolean
— description string
— dhcp keyword direction keyword
— apply-groups reference
— apply-groups-exclude reference
— script reference
— dhcp6 keyword direction keyword
— apply-groups reference
— apply-groups-exclude reference
— script reference
— diameter keyword direction keyword
— apply-groups reference
— apply-groups-exclude reference
— script reference
— gtpv1-c keyword direction keyword
— apply-groups reference
— apply-groups-exclude reference
— script reference
— gtpv2-c keyword direction keyword
— apply-groups reference
— apply-groups-exclude reference
— script reference
— nat-group reference
— pfcp keyword direction keyword
— apply-groups reference
— apply-groups-exclude reference
— script reference
— pppoe keyword direction keyword
— apply-groups reference
— apply-groups-exclude reference
— script reference
— radius keyword direction keyword
— apply-groups reference
— apply-groups-exclude reference
— script reference
— syslog
— apply-groups reference
— apply-groups-exclude reference
— script reference
— vsd
— apply-groups reference
— apply-groups-exclude reference
— script reference
— wlan-gw-group reference
— python-script string
— action-on-fail keyword
— admin-state keyword
— apply-groups reference
— apply-groups-exclude reference
— description string
— protection
— hmac-sha256 string
— run-as-user string
— urls string
— version keyword
python command descriptions
python
python-policy [name] string
Synopsis | Enter the python-policy list instance | |
Context | configure python python-policy string | |
Tree | python-policy | |
Max. Instances | 64 | |
Introduced | 16.0.R1 | |
Platforms | All |
[name] string
Synopsis | Python policy name | |
Context | configure python python-policy string | |
Tree | python-policy | |
String Length | 1 to 32 | |
Notes | This element is part of a list key. | |
Introduced | 16.0.R1 | |
Platforms | All |
cache
Synopsis | Enable the cache context | |
Context | configure python python-policy string cache | |
Tree | cache | |
Introduced | 16.0.R1 | |
Platforms | All |
admin-state keyword
Synopsis | Administrative state of the Python cache | |
Context | configure python python-policy string cache admin-state keyword | |
Tree | admin-state | |
Default | disable | |
Options | ||
Introduced | 16.0.R1 | |
Platforms | All |
entry-size number
WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect. | ||
Synopsis | Maximum data structure size for Python cache entry | |
Context | configure python python-policy string cache entry-size number | |
Tree | entry-size | |
Range | 32 to 2048 | |
Default | 256 | |
Units | bytes | |
Introduced | 16.0.R1 | |
Platforms | All |
max-entries number
WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect. | ||
Synopsis | Maximum number of Python cache entries to be stored | |
Context | configure python python-policy string cache max-entries number | |
Tree | max-entries | |
Range | 1 to 1000000 | |
Default | 128000 | |
Introduced | 16.0.R1 | |
Platforms |
All |
max-entry-lifetime number
Synopsis | Maximum lifetime allowed for each entry of the Python cache of this Python policy | |
Context | configure python python-policy string cache max-entry-lifetime number | |
Tree | max-entry-lifetime | |
Range | 1 to 604800 | |
Default | 86400 | |
Units | seconds | |
Introduced | 16.0.R1 | |
Platforms | All |
mcs-peer
Synopsis | Enable the mcs-peer context | |
Context | configure python python-policy string cache mcs-peer | |
Tree | mcs-peer | |
Introduced | 16.0.R1 | |
Platforms | All |
ip-address reference
Synopsis | IP address of the MCS peer | |
Context | configure python python-policy string cache mcs-peer ip-address reference | |
Tree | ip-address | |
Reference | configure redundancy multi-chassis peer (ipv4-address-no-zone | ipv6-address-no-zone) | |
Notes | This element is mandatory. | |
Introduced | 16.0.R1 | |
Platforms | All |
sync-tag string
minimum-lifetimes
Synopsis | Enter the minimum-lifetimes context | |
Context | configure python python-policy string cache minimum-lifetimes | |
Tree | minimum-lifetimes | |
Introduced | 16.0.R1 | |
Platforms | All |
high-availability number
Synopsis | Minimum lifetime of a cache entry to be synced with CPM | |
Context | configure python python-policy string cache minimum-lifetimes high-availability number | |
Tree | high-availability | |
Range | 1 to 600 | |
Units | seconds | |
Introduced | 16.0.R1 | |
Platforms |
All |
multi-chassis-redundancy number
Synopsis | Minimum lifetime for synchronization with the MCS peer | |
Context | configure python python-policy string cache minimum-lifetimes multi-chassis-redundancy number | |
Tree | multi-chassis-redundancy | |
Range | 1 to 600 | |
Units | seconds | |
Introduced | 16.0.R1 | |
Platforms |
All |
persistence number
Synopsis | Minimum lifetime for cache entry to be made persistent | |
Context | configure python python-policy string cache minimum-lifetimes persistence number | |
Tree | persistence | |
Range | 1 to 1800 | |
Units | seconds | |
Introduced | 16.0.R1 | |
Platforms |
All |
persistence boolean
WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect. | ||
Synopsis | Allow persistency support for the cached entries of the Python policy | |
Context | configure python python-policy string cache persistence boolean | |
Tree | persistence | |
Default | false | |
Introduced | 16.0.R1 | |
Platforms | All |
description string
Synopsis | Text description | |
Context | configure python python-policy string description string | |
Tree | description | |
String Length | 1 to 80 | |
Introduced | 16.0.R1 | |
Platforms | All |
dhcp [message-type] keyword direction keyword
Synopsis | Enter the dhcp list instance | |
Context | configure python python-policy string dhcp keyword direction keyword | |
Tree | dhcp | |
Introduced | 16.0.R1 | |
Platforms | All |
[message-type] keyword
Synopsis | DHCP message type | |
Context | configure python python-policy string dhcp keyword direction keyword | |
Tree | dhcp | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 16.0.R1 | |
Platforms | All |
direction keyword
Synopsis | Event that is either incoming or outgoing | |
Context | configure python python-policy string dhcp keyword direction keyword | |
Tree | dhcp | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 16.0.R1 | |
Platforms | All |
script reference
Synopsis | Python script to handle the message | |
Context | configure python python-policy string dhcp keyword direction keyword script reference | |
Tree | script | |
Reference | configure python python-script string | |
Notes | This element is mandatory. | |
Introduced | 16.0.R1 | |
Platforms | All |
dhcp6 [message-type] keyword direction keyword
Synopsis | Enter the dhcp6 list instance | |
Context | configure python python-policy string dhcp6 keyword direction keyword | |
Tree | dhcp6 | |
Introduced | 16.0.R1 | |
Platforms | All |
[message-type] keyword
Synopsis | DHCPv6 message type | |
Context | configure python python-policy string dhcp6 keyword direction keyword | |
Tree | dhcp6 | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 16.0.R1 | |
Platforms | All |
direction keyword
Synopsis | Event that is either incoming or outgoing | |
Context | configure python python-policy string dhcp6 keyword direction keyword | |
Tree | dhcp6 | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 16.0.R1 | |
Platforms | All |
script reference
Synopsis | Python script to handle the message | |
Context | configure python python-policy string dhcp6 keyword direction keyword script reference | |
Tree | script | |
Reference | configure python python-script string | |
Notes | This element is mandatory. | |
Introduced | 16.0.R1 | |
Platforms | All |
diameter [message-type] keyword direction keyword
Synopsis | Enter the diameter list instance | |
Context | configure python python-policy string diameter keyword direction keyword | |
Tree | diameter | |
Introduced | 16.0.R1 | |
Platforms | All |
[message-type] keyword
Synopsis | Diameter message type | |
Context | configure python python-policy string diameter keyword direction keyword | |
Tree | diameter | |
Options | ||
Notes |
This element is part of a list key. | |
Introduced | 16.0.R1 | |
Platforms | All |
direction keyword
Synopsis | Event that is either incoming or outgoing | |
Context | configure python python-policy string diameter keyword direction keyword | |
Tree | diameter | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 16.0.R1 | |
Platforms | All |
script reference
Synopsis | Python script to handle the message | |
Context | configure python python-policy string diameter keyword direction keyword script reference | |
Tree | script | |
Reference | configure python python-script string | |
Notes | This element is mandatory. | |
Introduced | 16.0.R1 | |
Platforms | All |
gtpv1-c [message-type] keyword direction keyword
Synopsis | Enter the gtpv1-c list instance | |
Context | configure python python-policy string gtpv1-c keyword direction keyword | |
Tree | gtpv1-c | |
Introduced | 16.0.R1 | |
Platforms | All |
[message-type] keyword
Synopsis | GTPv1-C message type | |
Context | configure python python-policy string gtpv1-c keyword direction keyword | |
Tree | gtpv1-c | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 16.0.R1 | |
Platforms | All |
direction keyword
Synopsis | Event that is either incoming or outgoing | |
Context | configure python python-policy string gtpv1-c keyword direction keyword | |
Tree | gtpv1-c | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 16.0.R1 | |
Platforms | All |
script reference
Synopsis | Python script to handle the message | |
Context | configure python python-policy string gtpv1-c keyword direction keyword script reference | |
Tree | script | |
Reference | configure python python-script string | |
Notes | This element is mandatory. | |
Introduced | 16.0.R1 | |
Platforms | All |
gtpv2-c [message-type] keyword direction keyword
Synopsis | Enter the gtpv2-c list instance | |
Context | configure python python-policy string gtpv2-c keyword direction keyword | |
Tree | gtpv2-c | |
Introduced | 16.0.R1 | |
Platforms | All |
[message-type] keyword
Synopsis | GTPv2-C message type | |
Context | configure python python-policy string gtpv2-c keyword direction keyword | |
Tree | gtpv2-c | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 16.0.R1 | |
Platforms | All |
direction keyword
Synopsis | Event that is either incoming or outgoing | |
Context | configure python python-policy string gtpv2-c keyword direction keyword | |
Tree | gtpv2-c | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 16.0.R1 | |
Platforms | All |
script reference
Synopsis | Python script to handle the message | |
Context | configure python python-policy string gtpv2-c keyword direction keyword script reference | |
Tree | script | |
Reference | configure python python-script string | |
Notes | This element is mandatory. | |
Introduced | 16.0.R1 | |
Platforms | All |
nat-group reference
WARNING: Modifying this element recreates the parent element automatically for the new value to take effect. | ||
Synopsis | NAT ISA group for this Python policy | |
Context | configure python python-policy string nat-group reference | |
Tree | nat-group | |
Reference | ||
Notes | The following elements are part of a choice: nat-group or wlan-gw-group. | |
Introduced | 16.0.R1 | |
Platforms | 7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s |
pfcp [message-type] keyword direction keyword
Synopsis | Enter the pfcp list instance | |
Context | configure python python-policy string pfcp keyword direction keyword | |
Tree | pfcp | |
Introduced | 22.10.R1 | |
Platforms | 7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR |
[message-type] keyword
Synopsis | Message type applied to the script | |
Context | configure python python-policy string pfcp keyword direction keyword | |
Tree | pfcp | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 22.10.R1 | |
Platforms | 7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR |
direction keyword
Synopsis | Event that is either incoming or outgoing | |
Context | configure python python-policy string pfcp keyword direction keyword | |
Tree | pfcp | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 22.10.R1 | |
Platforms | 7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR |
script reference
Synopsis | Python script to handle the message | |
Context | configure python python-policy string pfcp keyword direction keyword script reference | |
Tree | script | |
Reference | configure python python-script string | |
Notes | This element is mandatory. | |
Introduced | 22.10.R1 | |
Platforms | 7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR |
pppoe [message-type] keyword direction keyword
Synopsis | Enter the pppoe list instance | |
Context | configure python python-policy string pppoe keyword direction keyword | |
Tree | pppoe | |
Introduced | 16.0.R1 | |
Platforms | All |
[message-type] keyword
Synopsis | PPPoE message type | |
Context | configure python python-policy string pppoe keyword direction keyword | |
Tree | pppoe | |
Options | ||
Notes |
This element is part of a list key. | |
Introduced | 16.0.R1 | |
Platforms | All |
direction keyword
Synopsis | Event that is either incoming or outgoing | |
Context | configure python python-policy string pppoe keyword direction keyword | |
Tree | pppoe | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 16.0.R1 | |
Platforms | All |
script reference
Synopsis | Python script to handle the message | |
Context | configure python python-policy string pppoe keyword direction keyword script reference | |
Tree | script | |
Reference | configure python python-script string | |
Notes | This element is mandatory. | |
Introduced | 16.0.R1 | |
Platforms | All |
radius [message-type] keyword direction keyword
Synopsis | Enter the radius list instance | |
Context | configure python python-policy string radius keyword direction keyword | |
Tree | radius | |
Introduced | 16.0.R1 | |
Platforms | All |
[message-type] keyword
Synopsis | RADIUS message type | |
Context | configure python python-policy string radius keyword direction keyword | |
Tree | radius | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 16.0.R1 | |
Platforms | All |
direction keyword
Synopsis | Event that is either incoming or outgoing | |
Context | configure python python-policy string radius keyword direction keyword | |
Tree | radius | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 16.0.R1 | |
Platforms | All |
script reference
Synopsis | Python script to handle the message | |
Context | configure python python-policy string radius keyword direction keyword script reference | |
Tree | script | |
Reference | configure python python-script string | |
Notes | This element is mandatory. | |
Introduced | 16.0.R1 | |
Platforms | All |
syslog
Synopsis | Enable the syslog context | |
Context | configure python python-policy string syslog | |
Tree | syslog | |
Introduced | 16.0.R1 | |
Platforms | All |
script reference
Synopsis | Python script name for outgoing syslog messages | |
Context | configure python python-policy string syslog script reference | |
Tree | script | |
Reference | configure python python-script string | |
Notes | This element is mandatory. | |
Introduced | 16.0.R1 | |
Platforms | All |
vsd
Synopsis | Enable the vsd context | |
Context | configure python python-policy string vsd | |
Tree | vsd | |
Introduced | 16.0.R1 | |
Platforms | All |
script reference
Synopsis | Python script name for the received XMPP Service-Config response messages | |
Context | configure python python-policy string vsd script reference | |
Tree | script | |
Reference | configure python python-script string | |
Notes | This element is mandatory. | |
Introduced | 16.0.R1 | |
Platforms | All |
wlan-gw-group reference
WARNING: Modifying this element recreates the parent element automatically for the new value to take effect. | ||
Synopsis | WLAN ISA group for this Python policy | |
Context | configure python python-policy string wlan-gw-group reference | |
Tree | wlan-gw-group | |
Reference | configure isa wlan-gw-group number | |
Notes | The following elements are part of a choice: nat-group or wlan-gw-group. | |
Introduced | 16.0.R1 | |
Platforms | 7750 SR, 7750 SR-e, 7750 SR-s |
python-script [name] string
Synopsis | Enter the python-script list instance | |
Context | configure python python-script string | |
Tree | python-script | |
Max. Instances | 256 | |
Introduced | 16.0.R1 | |
Platforms | All |
[name] string
Synopsis | Python script policy name | |
Context | configure python python-script string | |
Tree | python-script | |
String Length | 1 to 32 | |
Notes | This element is part of a list key. | |
Introduced | 16.0.R1 | |
Platforms | All |
action-on-fail keyword
Synopsis | Action taken when Python fails to modify the given message | |
Context | configure python python-script string action-on-fail keyword | |
Tree | action-on-fail | |
Default | drop | |
Options | ||
Introduced | 16.0.R1 | |
Platforms |
All |
admin-state keyword
Synopsis | Administrative state of the Python script | |
Context | configure python python-script string admin-state keyword | |
Tree | admin-state | |
Default | disable | |
Options | ||
Introduced | 16.0.R1 | |
Platforms | All |
description string
Synopsis | Text description | |
Context | configure python python-script string description string | |
Tree | description | |
String Length | 1 to 80 | |
Introduced | 16.0.R1 | |
Platforms | All |
protection
Synopsis | Enter the protection context | |
Context | configure python python-script string protection | |
Tree | protection | |
Introduced | 16.0.R1 | |
Platforms | All |
hmac-sha256 string
Synopsis | Python script to consist of the hash value as obtained by the hmac-sha256 hashing algorithm | |
Context | configure python python-script string protection hmac-sha256 string | |
Tree | hmac-sha256 | |
String Length | 1 to 199 | |
Introduced | 16.0.R1 | |
Platforms | All |
run-as-user string
Synopsis | User authenticated for scripts | |
Context | configure python python-script string run-as-user string | |
Tree | run-as-user | |
Description | This command configures a user that is different from the current user of the session. Script authentication, authorization, accounting, and any activity within the script, is run as the specified user. If this command is not configured, the current user of the session is used. | |
String Length | 1 to 32 | |
Introduced | 22.10.R1 | |
Platforms | All |
urls string
Synopsis | Script location in URL format | |
Context | configure python python-script string urls string | |
Tree | urls | |
String Length | 1 to 180 | |
Max. Instances | 3 | |
Notes | This element is ordered by the user. | |
Introduced | 16.0.R4 | |
Platforms | All |
version keyword
WARNING: Modifying this element recreates the parent element automatically for the new value to take effect. | ||
Synopsis | Python version the script is written for | |
Context | configure python python-script string version keyword | |
Tree | version | |
Default | python2 | |
Options | ||
Introduced | 21.2.R1 | |
Platforms | All |