{ "id":"/axapi/v3/object-group", "type":"object", "node-type":"intermediate", "title":"object-group", "operation-not-allowed": ["PUT", "POST", "DELETE"], "partition-visibility":"shared", "description":"Configure Object Group", "properties":{ "network-list":{ "type":"array", "minItems":1, "items":{ "type":"network" }, "uniqueItems":true, "$ref":"/axapi/v3/object-group/network/{net-name}", "array":[ { "properties":{ "net-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Network Object Group Name", "optional":false }, "usage":{ "type":"string", "format":"enum", "default":"acl", "partition-visibility":"shared", "description":"'acl': Use for access-lists (default).; 'fw': Use for Firewall rule-set; ", "enum":[ "acl", "fw" ], "optional":true }, "ip-version":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'v4': IPv4 rule; 'v6': IPv6 rule; ", "enum":[ "v4", "v6" ], "optional":true }, "description":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Description of the object-group instance", "optional":true }, "rules":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "seq-num":{ "type":"number", "format":"number", "minimum":1, "maximum":8192, "partition-visibility":"shared", "description":"Sequence number" }, "host-v4":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"IPv4 Host Address" }, "host-v6":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "description":"IPv6 Host Address" }, "ip-range-start":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"IPv4 Host Address start" }, "ip-range-end":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"IPV4 Host address end" }, "ipv6-range-start":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "description":"IPv6 Host Address start" }, "ipv6-range-end":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "description":"IPV6 Host address end" }, "any":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Any host" }, "subnet":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"IPv4 Network Address" }, "rev-subnet-mask":{ "type":"string", "format":"ipv4-rev-netmask", "partition-visibility":"shared", "description":"Network Mask. 0=apply, 255=ignore" }, "fw-ipv4-address":{ "type":"string", "format":"ipv4-cidr", "partition-visibility":"shared", "description":"IPv4 Network Address" }, "ipv6-subnet":{ "type":"string", "format":"ipv6-address-plen", "partition-visibility":"shared", "description":"IPv6 Network Address" }, "fw-ipv6-subnet":{ "type":"string", "format":"ipv6-address-plen", "partition-visibility":"shared", "description":"IPv6 Network Address" }, "obj-network":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/object/network", "description":"Network Object" }, "slb-server":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/server", "description":"Server" }, "slb-vserver":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/slb/virtual-server", "description":"Virtual Server" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "net-name" ] } ] }, "service-list":{ "type":"array", "minItems":1, "items":{ "type":"service" }, "uniqueItems":true, "$ref":"/axapi/v3/object-group/service/{svc-name}", "array":[ { "properties":{ "svc-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Service Object Group Name", "optional":false }, "description":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Description of the object-group instance", "optional":true }, "rules":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "seq-num":{ "type":"number", "format":"number", "minimum":1, "maximum":8192, "partition-visibility":"shared", "description":"Sequence number" }, "protocol-id":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "partition-visibility":"shared", "description":"Protocol ID" }, "tcp-udp":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'tcp': Protocol TCP; 'udp': Protocol UDP; ", "enum":[ "tcp", "udp" ] }, "icmp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Internet Control Message Protocol" }, "icmpv6":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Internet Control Message Protocol version 6" }, "icmp-type":{ "type":"number", "format":"number", "minimum":0, "maximum":254, "partition-visibility":"shared", "not-list":[ "any-type", "special-type" ], "description":"ICMP type number" }, "any-type":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "icmp-type", "special-type" ], "description":"Any ICMP type" }, "special-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "icmp-type", "any-type" ], "description":"'echo-reply': Type 0, echo reply; 'echo-request': Type 8, echo request; 'info-reply': Type 16, information reply; 'info-request': Type 15, information request; 'mask-reply': Type 18, address mask reply; 'mask-request': Type 17, address mask request; 'parameter-problem': Type 12, parameter problem; 'redirect': Type 5, redirect message; 'source-quench': Type 4, source quench; 'time-exceeded': Type 11, time exceeded; 'timestamp': Type 13, timestamp; 'timestamp-reply': Type 14, timestamp reply; 'dest-unreachable': Type 3, destination unreachable; ", "enum":[ "echo-reply", "echo-request", "info-reply", "info-request", "mask-reply", "mask-request", "parameter-problem", "redirect", "source-quench", "time-exceeded", "timestamp", "timestamp-reply", "dest-unreachable" ] }, "any-code":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "icmp-code", "special-code" ], "description":"Any ICMP code" }, "icmp-code":{ "type":"number", "format":"number", "minimum":0, "maximum":254, "partition-visibility":"shared", "not-list":[ "any-code", "special-code" ], "description":"ICMP code number" }, "special-code":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "any-code", "icmp-code" ], "description":"'frag-required': Code 4, fragmentation required; 'host-unreachable': Code 1, destination host unreachable; 'network-unreachable': Code 0, destination network unreachable; 'port-unreachable': Code 3, destination port unreachable; 'proto-unreachable': Code 2, destination protocol unreachable; 'route-failed': Code 5, source route failed; ", "enum":[ "frag-required", "host-unreachable", "network-unreachable", "port-unreachable", "proto-unreachable", "route-failed" ] }, "icmpv6-type":{ "type":"number", "format":"number", "minimum":0, "maximum":254, "partition-visibility":"shared", "not-list":[ "v6-any-type", "special-v6-type" ], "description":"ICMPv6 type number" }, "v6-any-type":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "icmpv6-type", "special-v6-type" ], "description":"Any ICMP type" }, "special-v6-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "icmpv6-type", "v6-any-type" ], "description":"'dest-unreachable': Type 1, destination unreachable; 'echo-reply': Type 129, echo reply; 'echo-request': Type 128, echo request; 'packet-too-big': Type 2, packet too big; 'param-prob': Type 4, parameter problem; 'time-exceeded': Type 3, time exceeded; ", "enum":[ "dest-unreachable", "echo-reply", "echo-request", "packet-too-big", "param-prob", "time-exceeded" ] }, "v6-any-code":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "icmpv6-code", "special-v6-code" ], "description":"Any ICMPv6 code" }, "icmpv6-code":{ "type":"number", "format":"number", "minimum":0, "maximum":254, "partition-visibility":"shared", "not-list":[ "v6-any-code", "special-v6-code" ], "description":"ICMPv6 code number" }, "special-v6-code":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not-list":[ "v6-any-code", "icmpv6-code" ], "description":"'addr-unreachable': Code 3, address unreachable; 'admin-prohibited': Code 1, admin prohibited; 'no-route': Code 0, no route to destination; 'not-neighbour': Code 2, not neighbor; 'port-unreachable': Code 4, destination port unreachable; ", "enum":[ "addr-unreachable", "admin-prohibited", "no-route", "not-neighbour", "port-unreachable" ] }, "source":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Source Port Information" }, "eq-src":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Match only packets on a given source port (port number)" }, "gt-src":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "partition-visibility":"shared", "description":"Match only packets with a greater source port number" }, "lt-src":{ "type":"number", "format":"number", "minimum":2, "maximum":65535, "partition-visibility":"shared", "description":"Match only packets with a lower source port number" }, "range-src":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"match only packets in the range of source port numbers (Starting Port Number)" }, "port-num-end-src":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Ending Source Port Number" }, "eq-dst":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Match only packets on a given destination port (port number)" }, "gt-dst":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "partition-visibility":"shared", "description":"Match only packets with a greater destination port number" }, "lt-dst":{ "type":"number", "format":"number", "minimum":2, "maximum":65535, "partition-visibility":"shared", "description":"Match only packets with a lesser destination port number" }, "range-dst":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Match only packets in the range of destination port numbers (Starting Destination Port Number)" }, "port-num-end-dst":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Ending Destination Port Number" }, "alg":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'FTP': Specify FTP ALG port range; 'TFTP': Specify TFTP ALG port range; 'SIP': Specify SIP ALG port range; 'DNS': Specify DNS ALG port range; 'PPTP': Specify PPTP ALG port range; 'RTSP': Specify RTSP ALG port range; ", "enum":[ "FTP", "TFTP", "SIP", "DNS", "PPTP", "RTSP" ] } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "svc-name" ] } ] }, "application-list":{ "type":"array", "minItems":1, "items":{ "type":"application" }, "uniqueItems":true, "$ref":"/axapi/v3/object-group/application/{app-name}", "array":[ { "properties":{ "app-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Application Object Group Name", "optional":false }, "app-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "protocol":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify application" }, "protocol-tag":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'aaa': Protocol/application used for AAA (Authentification, Authorization and Accounting) purposes.; 'adult-content': Adult content protocol/application.; 'advertising': Advertising networks and applications.; 'application-enforcing-tls': Application known to enforce HSTS and thus use of TLS.; 'analytics-and-statistics': User analytics and statistics protocol/application.; 'anonymizers-and-proxies': Traffic-anonymization protocol/application.; 'audio-chat': Protocol/application used for Audio Chat.; 'basic': Covers all protocols required for basic classification, including most networking protocols as well as standard protocols like HTTP.; 'blog': Blogging platform protocol/application.; 'cdn': Protocol/application used for Content-Delivery Networks.; 'certification-authority': Certification Authority for SSL/TLS certificate.; 'chat': Protocol/application used for Text Chat.; 'classified-ads': Protocol/application used for Classified Advertisements.; 'cloud-based-services': SaaS and/or PaaS cloud based services.; 'crowdfunding': Service for funding a project or venture by raising small amounts of money from a large number of people, typically via the Internet.; 'cryptocurrency': Services for mining cryptocurrencies, for example a Crypto Web Browser (an application that mines crypto currency in the background while its user browses the web).; 'database': Database-specific protocols.; 'disposable-email': Service offering Disposable Email Accounts (DEA). DEA is a technique to share temporary email address between many users.; 'ebook-reader': Services for e-book readers, i.e. connected devices that display electronic books (typically using e-ink displays to reduce glare and eye strain).; 'education': Protocols offering education services and online courses.; 'email': Native email protocol.; 'enterprise': Protocol/application used in an enterprise network.; 'file-management': Protocol/application designed specifically for file management and exchange. This can include bona fide network protocols (like SMB) as well as web/cloud services (like Dropbox).; 'file-transfer': Protocol that offers file transferring as a secondary feature. This typically includes IM, WebMail, and other protocols that allow file transfers in addition to their principal function.; 'forum': Online forum protocol/application.; 'gaming': Protocol/application used by games.; 'healthcare': Protocols offering medical services, i.e protocols used in medical environment.; 'instant-messaging-and-multimedia-conferencing': Protocol/application used for Instant Messaging or Multi-Conferencing.; 'internet-of-things': Internet Of Things protocol/application.; 'map-service': Digital Maps service (web site and their related API).; 'mobile': Mobile-specific protocol/application.; 'multimedia-streaming': Protocol/application used for multimedia streaming.; 'networking': Protocol used for (inter) networking purpose.; 'news-portal': Protocol/application used for News Portals.; 'payment-service': Application offering online services for accepting electronic payments by a variety of payment methods (credit card, bank-based payments such as direct debit, bank transfer, etc).; 'peer-to-peer': Protocol/application used for Peer-to-peer purposes.; 'remote-access': Protocol/application used for remote access.; 'scada': SCADA (Supervisory control and data acquisition) protocols, all generations.; 'social-networks': Social networking application.; 'software-update': Auto-update protocol.; 'speedtest': Speedtest application allowing to access quality of Internet connection (upload, download, latency, etc).; 'standards-based': Protocol issued from standardized bodies such as IETF, ITU, IEEE, ETSI, OIF.; 'transportation': Transportation services, for example smartphone applications that allow users to hail a taxi.; 'video-chat': Protocol/application used for Video Chat.; 'voip': Application used for Voice-Over-IP.; 'vpn-tunnels': Protocol/application used for VPN or tunneling purposes.; 'web': Application based on HTTP/HTTPS.; 'web-e-commerce': Protocol/application used for E-commerce websites.; 'web-search-engines': Protocol/application used for Web search portals.; 'web-websites': Protocol/application used for Company Websites.; 'webmails': Web-based e-mail application.; 'web-ext-adult': Web Extension Adult; 'web-ext-auctions': Web Extension Auctions; 'web-ext-blogs': Web Extension Blogs; 'web-ext-business-and-economy': Web Extension Business and Economy; 'web-ext-cdns': Web Extension CDNs; 'web-ext-collaboration': Web Extension Collaboration; 'web-ext-computer-and-internet-info': Web Extension Computer and Internet Info; 'web-ext-computer-and-internet-security': Web Extension Computer and Internet Security; 'web-ext-dating': Web Extension Dating; 'web-ext-educational-institutions': Web Extension Educational Institutions; 'web-ext-entertainment-and-arts': Web Extension Entertainment and Arts; 'web-ext-fashion-and-beauty': Web Extension Fashion and Beauty; 'web-ext-file-share': Web Extension File Share; 'web-ext-financial-services': Web Extension Financial Services; 'web-ext-gambling': Web Extension Gambling; 'web-ext-games': Web Extension Games; 'web-ext-government': Web Extension Government; 'web-ext-health-and-medicine': Web Extension Health and Medicine; 'web-ext-individual-stock-advice-and-tools': Web Extension Individual Stock Advice and Tools; 'web-ext-internet-portals': Web Extension Internet Portals; 'web-ext-job-search': Web Extension Job Search; 'web-ext-local-information': Web Extension Local Information; 'web-ext-malware': Web Extension Malware; 'web-ext-motor-vehicles': Web Extension Motor Vehicles; 'web-ext-music': Web Extension Music; 'web-ext-news': Web Extension News; 'web-ext-p2p': Web Extension P2P; 'web-ext-parked-sites': Web Extension Parked Sites; 'web-ext-proxy-avoid-and-anonymizers': Web Extension Proxy Avoid and Anonymizers; 'web-ext-real-estate': Web Extension Real Estate; 'web-ext-reference-and-research': Web Extension Reference and Research; 'web-ext-search-engines': Web Extension Search Engines; 'web-ext-shopping': Web Extension Shopping; 'web-ext-social-network': Web Extension Social Network; 'web-ext-society': Web Extension Society; 'web-ext-software': Web Extension Software; 'web-ext-sports': Web Extension Sports; 'web-ext-streaming-media': Web Extension Streaming Media; 'web-ext-training-and-tools': Web Extension Training and Tools; 'web-ext-translation': Web Extension Translation; 'web-ext-travel': Web Extension Travel; 'web-ext-web-advertisements': Web Extension Web Advertisements; 'web-ext-web-based-email': Web Extension Web based Email; 'web-ext-web-hosting': Web Extension Web Hosting; 'web-ext-web-service': Web Extension Web Service; ", "enum":[ "aaa", "adult-content", "advertising", "application-enforcing-tls", "analytics-and-statistics", "anonymizers-and-proxies", "audio-chat", "basic", "blog", "cdn", "certification-authority", "chat", "classified-ads", "cloud-based-services", "crowdfunding", "cryptocurrency", "database", "disposable-email", "ebook-reader", "education", "email", "enterprise", "file-management", "file-transfer", "forum", "gaming", "healthcare", "instant-messaging-and-multimedia-conferencing", "internet-of-things", "map-service", "mobile", "multimedia-streaming", "networking", "news-portal", "payment-service", "peer-to-peer", "remote-access", "scada", "social-networks", "software-update", "speedtest", "standards-based", "transportation", "video-chat", "voip", "vpn-tunnels", "web", "web-e-commerce", "web-search-engines", "web-websites", "webmails", "web-ext-adult", "web-ext-auctions", "web-ext-blogs", "web-ext-business-and-economy", "web-ext-cdns", "web-ext-collaboration", "web-ext-computer-and-internet-info", "web-ext-computer-and-internet-security", "web-ext-dating", "web-ext-educational-institutions", "web-ext-entertainment-and-arts", "web-ext-fashion-and-beauty", "web-ext-file-share", "web-ext-financial-services", "web-ext-gambling", "web-ext-games", "web-ext-government", "web-ext-health-and-medicine", "web-ext-individual-stock-advice-and-tools", "web-ext-internet-portals", "web-ext-job-search", "web-ext-local-information", "web-ext-malware", "web-ext-motor-vehicles", "web-ext-music", "web-ext-news", "web-ext-p2p", "web-ext-parked-sites", "web-ext-proxy-avoid-and-anonymizers", "web-ext-real-estate", "web-ext-reference-and-research", "web-ext-search-engines", "web-ext-shopping", "web-ext-social-network", "web-ext-society", "web-ext-software", "web-ext-sports", "web-ext-streaming-media", "web-ext-training-and-tools", "web-ext-translation", "web-ext-travel", "web-ext-web-advertisements", "web-ext-web-based-email", "web-ext-web-hosting", "web-ext-web-service" ] } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "app-name" ] } ] } } }