Welcome to smc-python’s documentation!
Contents:
- Introduction
- Installation
- Enable API on SMC
- Creating the session
- Resources
- Collections
- Elements
- Engines
- Policies
- VPN
- Administration
- Logging
- Extensions
- smc-python-monitoring
- Query
Query
Query.add_and_filter()
Query.add_defined_filter()
Query.add_in_filter()
Query.add_not_filter()
Query.add_or_filter()
Query.add_translated_filter()
Query.execute()
Query.fetch_as_element()
Query.fetch_batch()
Query.fetch_live()
Query.fetch_raw()
Query.resolve_field_ids()
Query.update_filter()
Query.update_format()
- Models
- Filters
- Values
- Formats
- Constants
Actions
Alerts
DataType
LogField
LogField.ACCELAPSED
LogField.ACCRXBYTES
LogField.ACCRXPACKETS
LogField.ACCTXBYTES
LogField.ACCTXPACKETS
LogField.ACK
LogField.ACTION
LogField.ALERT
LogField.ALERTCOUNT
LogField.ALERTERTRACE
LogField.ALERTSEVERITY
LogField.ALERTSTATUS
LogField.ALLOWEDDATATAG
LogField.APPLICATION
LogField.APPLICATIONCOMBINATIONFLAGS
LogField.APPLICATIONDETAIL
LogField.APPLICATIONUSAGE
LogField.ASPAMEMAILMESSAGEID
LogField.ASPAMEMAILSCORE
LogField.ASPAMEMAILSUBJECT
LogField.ASPAMRECEIVEREMAIL
LogField.ASPAMSENDEREMAIL
LogField.ASPAMSENDERMTA
LogField.AUTHENTICATIONCOUNTER
LogField.AUTHMETHOD
LogField.AUTHNAME
LogField.AUTHRULEID
LogField.BALANCINGPROBING
LogField.BALANCINGSELECTION
LogField.BLACKLISTENTRYDESTINATIONIP
LogField.BLACKLISTENTRYDESTINATIONIPMASK
LogField.BLACKLISTENTRYDESTINATIONPORT
LogField.BLACKLISTENTRYDESTINATIONPORTRANGE
LogField.BLACKLISTENTRYDURATION
LogField.BLACKLISTENTRYID
LogField.BLACKLISTENTRYPROTOCOL
LogField.BLACKLISTENTRYSOURCEIP
LogField.BLACKLISTENTRYSOURCEIPMASK
LogField.BLACKLISTENTRYSOURCEIPPREFIXLEN
LogField.BLACKLISTENTRYSOURCEPORT
LogField.BLACKLISTENTRYSOURCEPORTRANGE
LogField.BLACKLISTER
LogField.BLOCK_LISTENTRYDESTINATIONIP
LogField.BLOCK_LISTENTRYDESTINATIONIPMASK
LogField.BLOCK_LISTENTRYDESTINATIONPORT
LogField.BLOCK_LISTENTRYDESTINATIONPORTRANGE
LogField.BLOCK_LISTENTRYDURATION
LogField.BLOCK_LISTENTRYID
LogField.BLOCK_LISTENTRYPROTOCOL
LogField.BLOCK_LISTENTRYSOURCEIP
LogField.BLOCK_LISTENTRYSOURCEIPMASK
LogField.BLOCK_LISTENTRYSOURCEIPPREFIXLEN
LogField.BLOCK_LISTENTRYSOURCEPORT
LogField.BLOCK_LISTENTRYSOURCEPORTRANGE
LogField.BLOCK_LISTER
LogField.CIPHERALG
LogField.CLIENTIPADDRESS
LogField.COMPID
LogField.CONNDIRECTION
LogField.CONNECTEDMACADDR
LogField.CONNECTIVITY
LogField.CONNSTATUS
LogField.CONNTYPE
LogField.CONTAINEDDATATAG
LogField.CONTROLCOMMANDID
LogField.DATATAG
LogField.DATATAGS
LogField.DATATYPE
LogField.DHCPLEASEEXPIRES
LogField.DHCPLEASEGW
LogField.DHCPLEASEIP
LogField.DHCPLEASENETMASK
LogField.DHCPLEASEPREFIXLEN
LogField.DHCPLEASERECEIVED
LogField.DHCPLEASES
LogField.DPD
LogField.DPORT
LogField.DSCPMARK
LogField.DST
LogField.DSTADDRS
LogField.DSTIF
LogField.DSTIPRANGE
LogField.DSTVLAN
LogField.DSTZONE
LogField.ELEMENTDOMAIN
LogField.ENDPOINT
LogField.ENTERPRISEOID
LogField.EVENT
LogField.EVENTADDRESS
LogField.EVENTINFO
LogField.EVENTLOGID
LogField.EVENTTIME
LogField.EVENTTYPE
LogField.EVENTUSER
LogField.EXPIRATIONTIME
LogField.FACILITY
LogField.FILETYPECOMPAT
LogField.FLAG
LogField.FPCACHED
LogField.FW100INTERFACE
LogField.FW100TRAFFICCOUNTERS
LogField.FWACCEPTEDBYTES
LogField.FWACCEPTEDPACKETS
LogField.FWACCOUNTEDBYTES
LogField.FWACCOUNTEDPACKETS
LogField.FWADSLRXBYTES
LogField.FWADSLTXBYTES
LogField.FWDECRYPTEDBYTES
LogField.FWDECRYPTEDPACKETS
LogField.FWDROPPEDBYTES
LogField.FWDROPPEDPACKETS
LogField.FWENCRYPTEDBYTES
LogField.FWENCRYPTEDPACKETS
LogField.FWFORWARDEDBYTES
LogField.FWFORWARDEDPACKETS
LogField.FWINTERFACEKEY
LogField.FWNATTEDBYTES
LogField.FWNATTEDPACKETS
LogField.FWRECEIVEDBYTES
LogField.FWRECEIVEDPACKETS
LogField.FWSENTBYTES
LogField.FWSENTPACKETS
LogField.FWTRAFFIC
LogField.FWTRAFFICACCOUNTEDBYTES
LogField.FWTRAFFICACCOUNTEDPACKETS
LogField.FWTRAFFICALLOWEDBYTES
LogField.FWTRAFFICALLOWEDPACKETS
LogField.FWTRAFFICDISCARDEDBYTES
LogField.FWTRAFFICDISCARDEDPACKETS
LogField.FWTRAFFICENCRYPTEDBYTES
LogField.FWTRAFFICENCRYPTEDPACKETS
LogField.FWTRAFFICLOGGEDBYTES
LogField.FWTRAFFICLOGGEDPACKETS
LogField.FWTRAFFICNATTEDBYTES
LogField.FWTRAFFICNATTEDPACKETS
LogField.GENERICTRAPTYPE
LogField.HASHALG
LogField.HITS
LogField.HTTPREQUESTHOST
LogField.ICMPCODE
LogField.ICMPID
LogField.ICMPTYPE
LogField.IKEDHGROUP
LogField.IKELOCALID
LogField.IKEREMOTEID
LogField.IKEV1MODE
LogField.INCIDENTCASE
LogField.INFOMSG
LogField.INTERFACE
LogField.IPCOMPRESSION
LogField.IPSAPPID
LogField.IPSECSSPI
LogField.LOGID
LogField.LOGIFTOPDESTINATIONIPADDRS
LogField.LOGIFTOPSOURCEIPADDRS
LogField.LOGSEVERITY
LogField.LONGMSG
LogField.MACALG
LogField.MESSAGEID
LogField.NATBALANCEID
LogField.NATDPORT
LogField.NATDST
LogField.NATMAPID
LogField.NATRULEID
LogField.NATSPORT
LogField.NATSRC
LogField.NATT
LogField.NEGOTIATIONROLE
LogField.NEIGHBORINTERFACE
LogField.NEIGHBORL2DATA
LogField.NEIGHBORL3DATA
LogField.NEIGHBORPROTOCOL
LogField.NEIGHBORSTATE
LogField.NODECAPACITY
LogField.NODECONFIGURATION
LogField.NODECONFIGURATIONTIMESTAMP
LogField.NODEDYNUP
LogField.NODEHWSTATUS
LogField.NODEID
LogField.NODELOAD
LogField.NODESTATUS
LogField.NODEVERSION
LogField.NONCONTAINEDDATATAG
LogField.NUMALERTRESPONSES
LogField.NUMBLACKLISTRESPONSES
LogField.NUMBLOCK_LISTRESPONSES
LogField.NUMBYTESRECEIVED
LogField.NUMBYTESSENT
LogField.NUMDISCARDRESPONSES
LogField.NUMLOGEVENTS
LogField.NUMLOGRESPONSES
LogField.NUMPACKETSRECEIVED
LogField.NUMPACKETSSENT
LogField.NUMRECORDRESPONSES
LogField.NUMRESETRESPONSES
LogField.OBJECTDN
LogField.OBJECTKEY
LogField.OBJECTNAME
LogField.OBJECTTYPE
LogField.ORIGINNAME
LogField.OUTBOUNDSPI
LogField.PASSEDBYTES
LogField.PEERCOMPONENTID
LogField.PEERENDPOINT
LogField.PEERSECURITYGATEWAY
LogField.PFSDHGROUP
LogField.PHASE1FAIL
LogField.PHASE1SUCC
LogField.PHASE2FAIL
LogField.PHASE2SUCC
LogField.POTENTIALLYDUPLICATERESPONSE
LogField.PROBEFAIL
LogField.PROBEOK
LogField.PROTOCOL
LogField.QOSCLASS
LogField.QOSPRIORITY
LogField.RADIUSACCOUNTINGTYPE
LogField.RECEIVEDLOGEVENTS
LogField.RECEPTIONTIME
LogField.RESOURCE
LogField.RESULT
LogField.RETSRCIF
LogField.ROUTEBGPPATH
LogField.ROUTEDISTANCE
LogField.ROUTEGATEWAY
LogField.ROUTEMETRIC
LogField.ROUTENETMASK
LogField.ROUTENETWORK
LogField.ROUTEOSPFLSATYPE
LogField.ROUTETYPE
LogField.RTT
LogField.RULECOUNTERS
LogField.RULEHITS
LogField.RULEID
LogField.RWPHTTPREFERRER
LogField.RWPHTTPUSERAGENT
LogField.RWPSERVICENAME
LogField.SAAUTHALG
LogField.SABUNDLE
LogField.SACIPHERALG
LogField.SACLASS
LogField.SACOMPRESSIONALG
LogField.SAEXPIREHARDLIMIT
LogField.SAEXPIRESOFTLIMIT
LogField.SAINCOMING
LogField.SAKBHARDLIMIT
LogField.SAKBSOFTLIMIT
LogField.SARESPONDER
LogField.SATYPE
LogField.SECURITYGATEWAY
LogField.SELECTEDCACHE
LogField.SELECTEDRTT
LogField.SENDER
LogField.SENDERDOMAIN
LogField.SENDERTYPE
LogField.SENSORALLOWEDINSPECTEDTCPCONNECTIONS
LogField.SENSORALLOWEDINSPECTEDUDPCONNECTIONS
LogField.SENSORALLOWEDUNINSPECTEDTCPCONNECTIONS
LogField.SENSORALLOWEDUNINSPECTEDUDPCONNECTIONS
LogField.SENSORDISCARDEDTCPCONNECTIONS
LogField.SENSORDISCARDEDUDPCONNECTIONS
LogField.SENSORINSPECTEDBYTES
LogField.SENSORINSPECTEDPACKETS
LogField.SENSORINTERFACEKEY
LogField.SENSORLOSTBYTES
LogField.SENSORLOSTPACKETS
LogField.SENSORPROCESSEDBYTES
LogField.SENSORPROCESSEDPACKETS
LogField.SENSORRECEIVEDBYTES
LogField.SENSORRECEIVEDPACKETS
LogField.SENSORTRAFFIC
LogField.SENSORTRAFFICCLOSEDTCPCONNECTIONS
LogField.SENSORTRAFFICINSPECTEDPACKETS
LogField.SENSORTRAFFICLOSTPACKETS
LogField.SENSORTRAFFICNEWTCPCONNECTIONS
LogField.SENSORTRAFFICNUMBEROFALERTS
LogField.SENSORTRAFFICOKCONNECTIONS
LogField.SENSORTRAFFICPROCESSEDBYTES
LogField.SENSORTRAFFICPROCESSEDPACKETS
LogField.SENSORTRAFFICSTATSOFPACKETS
LogField.SENSORTRAFFICSUSPICIOUSCONNECTIONS
LogField.SENSORTRAFFICTCPHANDSHAKES
LogField.SENSORTRAFFICTCPTIMEOUTS
LogField.SENTLOGEVENTS
LogField.SERVICEKEY
LogField.SESSIONDOMAIN
LogField.SESSIONEVENT
LogField.SESSIONID
LogField.SFPINGRESS
LogField.SHAPINGCLASS
LogField.SHAPINGGUARANTEE
LogField.SHAPINGLIMIT
LogField.SHAPINGPRIORITY
LogField.SITCATEGORY
LogField.SITUATION
LogField.SNMPRETSRCIF
LogField.SNMPSRCIF
LogField.SNMPTRAPMAP
LogField.SNMPTRAPOID
LogField.SNMPTRAPVALUE
LogField.SPORT
LogField.SRC
LogField.SRCADDRESS
LogField.SRCADDRS
LogField.SRCIF
LogField.SRCIPRANGE
LogField.SRCVLAN
LogField.SRCZONE
LogField.SRVHELPERID
LogField.SSLVPNSESSIONMONID
LogField.SSLVPNSESSIONMONRECEIVED
LogField.SSLVPNSESSIONMONTIMEOUT
LogField.SSLVPNSESSIONTYPETYPE
LogField.STATE
LogField.STATUSTYPE
LogField.STORAGESERVERID
LogField.SYSLOGTYPE
LogField.TAGINFO
LogField.TCPDUMPSTATUS
LogField.TCPENCAPSULATION
LogField.TIMEOUT
LogField.TIMESTAMP
LogField.TLSALERTDESCRIPTION
LogField.TLSALERTLEVEL
LogField.TLSCERTIFICATEVERIFYERRORCODE
LogField.TLSCIPHERSUITE
LogField.TLSCOMPRESSIONMETHOD
LogField.TLSDETECTED
LogField.TLSDOMAIN
LogField.TLSPROTOCOLVERSION
LogField.TOTALBYTES
LogField.TPACCEPTEDBYTES
LogField.TPACCEPTEDPACKETS
LogField.TPDROPPEDBYTES
LogField.TPDROPPEDPACKETS
LogField.TPMEMUSAGE
LogField.TPNODELOAD
LogField.TPRECEIVEDBYTES
LogField.TPRECEIVEDPACKETS
LogField.TPSENTBYTES
LogField.TPSENTPACKETS
LogField.TPTRAFFICCOUNTERS
LogField.TRAFFICCOUNTERS
LogField.TRAFFICSHAPING
LogField.TRANSIENT
LogField.TUNNELINGLEVEL
LogField.TYPE
LogField.TYPEDESCRIPTION
LogField.URLCATEGORYGROUP
LogField.URLCATEGORYRISK
LogField.USERNAME
LogField.USERORIGINATOR
LogField.USERROLE
LogField.VPNBYTESRECEIVED
LogField.VPNBYTESSENT
LogField.VPNID
LogField.VPNSRCID
LogField.VPNSTATISTICS
LogField.VPNSTATUS
LogField.VPNTYPE
LogField.VULNERABILITYREFERENCES
LogField.WIRELESSCHANNEL
LogField.WIRELESSCONNECTIONS
LogField.WIRELESSMONITORING
LogField.WIRELESSSECURITY
LogField.WIRELESSSSID
LogField.WIRELESSSTATUS
LogField.ZIPEXPORTFILE
- Formatters
- TimeRanges
- Monitors
- Blacklist
BlacklistEntry
BlacklistEntry.blacklist_entry_key
BlacklistEntry.blacklist_id
BlacklistEntry.delete()
BlacklistEntry.dest_ports
BlacklistEntry.destination
BlacklistEntry.duration
BlacklistEntry.engine
BlacklistEntry.first_fetch
BlacklistEntry.href
BlacklistEntry.protocol
BlacklistEntry.source
BlacklistEntry.source_ports
BlacklistEntry.timestamp
BlacklistQuery
- Connections
- Logs
- Routes
- SSLVPN
- Users
- VPNs
VPNSAQuery
VPNSecurityAssoc
VPNSecurityAssoc.bytes_received
VPNSecurityAssoc.bytes_sent
VPNSecurityAssoc.engine
VPNSecurityAssoc.expiration
VPNSecurityAssoc.first_fetch
VPNSecurityAssoc.local_endpoint
VPNSecurityAssoc.local_gateway
VPNSecurityAssoc.local_networks
VPNSecurityAssoc.negotiation_role
VPNSecurityAssoc.peer_endpoint
VPNSecurityAssoc.peer_gateway
VPNSecurityAssoc.peer_networks
VPNSecurityAssoc.protocol
VPNSecurityAssoc.sa_type
VPNSecurityAssoc.timestamp
- Alerts
- Blacklist
- Query
- smc-python-monitoring
- API Reference
- Session
- Element
- Administration
- Access Rights
- Alert Configuration
- Certificates
- Domains
- License
- Scheduled Tasks
ArchiveLogTask
DeleteLogTask
DeleteOldRunTask
DeleteOldSnapshotsTask
DisableUnusedAdminTask
ExportLogTask
FetchCertificateRevocationTask
RefreshMasterEnginePolicyTask
RefreshPolicyTask
RemoteUpgradeTask
RenewGatewayCertificatesTask
RenewInternalCATask
RenewInternalCertificatesTask
SGInfoTask
ScheduledTaskMixin
ServerBackupTask
SystemSnapsotTask
TaskSchedule
TrafficCaptureInterfaceSettings
TrafficCaptureTask
UploadPolicyTask
ValidatePolicyTask
log_target_types()
policy_validation_settings()
server_directories_settings()
server_directory()
- Reports
- System
AdminDomain
System
System.active_alerts_ack_all()
System.bind_license()
System.blacklist()
System.block_list()
System.block_list_bulk()
System.clean_invalid_filters()
System.delete_license()
System.empty_trash_bin()
System.engine_upgrade()
System.engine_upgrade_import()
System.export_elements()
System.export_ldif_elements()
System.find_system_element()
System.import_elements()
System.import_ldif_elements()
System.import_new_certificate_authority_certificate()
System.last_activated_package
System.license_check_for_new()
System.license_details()
System.license_fetch()
System.license_install()
System.licenses
System.massive_delete()
System.massive_license_bind
System.mgt_integration_configuration
System.references_by_element()
System.smc_certificate_authority()
System.smc_time
System.smc_version
System.system_properties()
System.system_property()
System.unlicensed_components()
System.upcoming_event()
System.upcoming_event_ignore_settings()
System.upcoming_event_policy()
System.update_package()
System.update_package_import()
System.update_system_property()
System.update_upcoming_event_ignore_settings()
System.update_upcoming_event_policy()
System.visible_security_group_mapping()
System.visible_virtual_engine_mapping()
- Tasks
- Upcoming Event
- Updates
- SD-WAN
- Elements
- Network
- Services
- Groups
- Servers
AuthenticationServerMixin
ContactAddressMixin
DataContext
ManagementLogServerMixin
ManagementLogServerMixin.add_netflow_collector()
ManagementLogServerMixin.elasticsearch_authentication_settings
ManagementLogServerMixin.es_tls_settings
ManagementLogServerMixin.external_pki_certificate_settings
ManagementLogServerMixin.forwarding_tls_settings
ManagementLogServerMixin.log_disk_space_handling_mode
ManagementLogServerMixin.netflow_collector
ManagementLogServerMixin.pki_certificate_info()
ManagementLogServerMixin.pki_certificate_settings()
ManagementLogServerMixin.pki_delete_certificate_request()
ManagementLogServerMixin.pki_export_certificate_request()
ManagementLogServerMixin.pki_import_certificate()
ManagementLogServerMixin.pki_renew_certificate()
ManagementLogServerMixin.remove_netflow_collector()
ManagementLogServerMixin.uiid
MultiContactAddress
NetflowCollector
TlsSettings
WebApp
- LogServer
- ManagementServer
ManagementServer
ManagementServer.alert_server_ref
ManagementServer.create()
ManagementServer.db_replication
ManagementServer.license_update_enabled
ManagementServer.mgt_integration_container
ManagementServer.restart_web_access()
ManagementServer.script_path
ManagementServer.sender_address
ManagementServer.sender_name
ManagementServer.sms_http_channel
ManagementServer.sms_script_channel
ManagementServer.sms_smtp_channel
ManagementServer.smtp_server_ref
ManagementServer.snmp_gateways
ManagementServer.tls_credentials
ManagementServer.tls_profile
ManagementServer.update()
ManagementServer.updates_check_enabled
ManagementServer.updates_proxy_address
ManagementServer.updates_proxy_authentication_enabled
ManagementServer.updates_proxy_enabled
ManagementServer.updates_proxy_password
ManagementServer.updates_proxy_port
ManagementServer.updates_proxy_username
ManagementServer.web_app
- DNSServer
- HttpProxy
- ProxyServer
ProxyServer
ProxyServer.add_x_forwarded_for
ProxyServer.balancing_mode
ProxyServer.create()
ProxyServer.fp_proxy_key
ProxyServer.fp_proxy_key_id
ProxyServer.fp_proxy_user_id
ProxyServer.inspected_services
ProxyServer.ip_address
ProxyServer.proxy_service
ProxyServer.trust_host_header
ProxyServer.update_or_create()
- DHCPServer
- WebPortalServer
- EpoServer
- LDAPServer
- ActiveDirectoryServer
- SmtpServer
- IcapServer
- RadiusServer
- TacacsServer
- NTPServer
- ElasticsearchCluster
ElasticsearchCluster
ElasticsearchCluster.addresses
ElasticsearchCluster.authentication_settings
ElasticsearchCluster.create()
ElasticsearchCluster.es_enable_cluster_sniffer
ElasticsearchCluster.es_retention_period
ElasticsearchCluster.es_shard_number
ElasticsearchCluster.es_tls_settings
ElasticsearchCluster.port
ElasticsearchCluster.update()
- Other
Blacklist
Blocklist
Category
CategoryTag
ContactAddress
FilterExpression
Geolocation
HTTPSInspectionExceptions
Location
LogicalInterface
MacAddress
QueryDataFilter
RuleValidityTime
SituationTag
UpdateServerProfile
prepare_blacklist()
prepare_block_list()
- Blacklist
- Category
- CategoryTag
- FilterExpression
- Location
- LogicalInterface
- MacAddress
- HTTPSInspectionExceptions
- Sidewinder Elements
- Situations
- Profiles
- Engine
Engine
Engine.add_interface()
Engine.add_link_usage_exception_rules()
Engine.add_route()
Engine.adsl_interface
Engine.alias_resolving()
Engine.all_vpns
Engine.antispoofing
Engine.antivirus
Engine.automatic_rules_settings
Engine.blacklist()
Engine.blacklist_bulk()
Engine.blacklist_flush()
Engine.blacklist_show()
Engine.block_list()
Engine.block_list_bulk()
Engine.block_list_flush()
Engine.block_list_show()
Engine.client_inspection
Engine.connection_timeout
Engine.contact_addresses
Engine.create_internal_gateway()
Engine.default_nat
Engine.delete_user_authentication_certificate()
Engine.delete_user_authentication_certificate_request()
Engine.discard_quic_if_cant_inspect
Engine.dns
Engine.dns_relay
Engine.dynamic_routing
Engine.endpoint_integration
Engine.export_user_authentication_certificate()
Engine.export_user_authentication_certificate_request()
Engine.file_reputation
Engine.generate_and_sign_user_authentication_certificate()
Engine.generate_snapshot()
Engine.generate_user_authentication_certificate_request()
Engine.geolocation
Engine.get_session_monitoring()
Engine.granted_permissions
Engine.installed_policy
Engine.interface
Engine.interface_options
Engine.internal_gateway
Engine.known_host_lists
Engine.l2fw_settings
Engine.lbfilter_useports
Engine.lbfilters
Engine.ldap_replication()
Engine.link_usage_exception_rules
Engine.link_usage_profile
Engine.lldp_profile
Engine.local_log_storage
Engine.location
Engine.log_moderation
Engine.log_server
Engine.loopback_interface
Engine.modem_interface
Engine.nodes
Engine.ntp_settings
Engine.pending_changes
Engine.permissions
Engine.physical_interface
Engine.policy_route
Engine.query_route()
Engine.refresh()
Engine.remove_alternative_policies()
Engine.remove_link_usage_exception_rules()
Engine.rename()
Engine.routing
Engine.routing_monitoring
Engine.sandbox
Engine.sidewinder_proxy
Engine.snapshots
Engine.snmp
Engine.switch_physical_interface
Engine.tls_inspection
Engine.tunnel_interface
Engine.upload()
Engine.upload_alternative_slot()
Engine.url_filtering
Engine.user_authentication_import_certificate()
Engine.version
Engine.virtual_physical_interface
Engine.virtual_resource
Engine.vpn
Engine.vpn_broker_interface
Engine.vpn_endpoint
Engine.vpn_mappings
Engine.wireless_interface
HAForSingleEngine
IdleTimeout
LBFilter
LinkUsageExceptionRules
LocalLogStorageSettings
VPN
VPNMapping
VPNMappingCollection
- AddOn
- Dynamic Routing
- General
- VPN
- Interfaces
- InterfaceCollections
InterfaceCollection
LoopbackCollection
PhysicalInterfaceCollection
PhysicalInterfaceCollection.add()
PhysicalInterfaceCollection.add_capture_interface()
PhysicalInterfaceCollection.add_cluster_interface_on_master_engine()
PhysicalInterfaceCollection.add_dhcp_interface()
PhysicalInterfaceCollection.add_inline_interface()
PhysicalInterfaceCollection.add_inline_ips_interface()
PhysicalInterfaceCollection.add_inline_l2fw_interface()
PhysicalInterfaceCollection.add_layer3_cluster_interface()
PhysicalInterfaceCollection.add_layer3_interface()
PhysicalInterfaceCollection.add_layer3_shared_virtual_interface()
PhysicalInterfaceCollection.add_layer3_vlan_cluster_interface()
SwitchInterfaceCollection
TunnelInterfaceCollection
VPNBrokerInterfaceCollection
VirtualPhysicalInterfaceCollection
Interface
Interface.add_ip_address()
Interface.addresses
Interface.all_interfaces
Interface.change_interface_id()
Interface.comment
Interface.contact_addresses
Interface.delete()
Interface.delete_invalid_route()
Interface.get_boolean()
Interface.has_interfaces
Interface.has_vlan
Interface.interface_id
Interface.interfaces
Interface.log_moderation
Interface.name
Interface.port_group_interface
Interface.reset_interface()
Interface.sub_interfaces()
Interface.update()
Interface.update_interface()
Interface.vlan_interface
Interface.zone
Interface.zone_ref
- InterfaceOptions
InterfaceOptions
InterfaceOptions.auth_request
InterfaceOptions.backup_heartbeat
InterfaceOptions.backup_mgt
InterfaceOptions.outgoing
InterfaceOptions.primary_heartbeat
InterfaceOptions.primary_mgt
InterfaceOptions.set_auth_request()
InterfaceOptions.set_backup_heartbeat()
InterfaceOptions.set_backup_mgt()
InterfaceOptions.set_outgoing()
InterfaceOptions.set_primary_heartbeat()
InterfaceOptions.set_primary_mgt()
- QoS
- LoopbackInterface
- LoopbackClusterInterface
- PhysicalInterface
PhysicalInterface
PhysicalInterface.aggregate_mode
PhysicalInterface.arp_entry
PhysicalInterface.change_vlan_id()
PhysicalInterface.enable_aggregate_mode()
PhysicalInterface.is_auth_request
PhysicalInterface.is_backup_heartbeat
PhysicalInterface.is_backup_mgt
PhysicalInterface.is_outgoing
PhysicalInterface.is_primary_heartbeat
PhysicalInterface.is_primary_mgt
PhysicalInterface.lldp_mode
PhysicalInterface.mtu
PhysicalInterface.multicast_ip
PhysicalInterface.ndi_interfaces
PhysicalInterface.qos
PhysicalInterface.second_interface_id
PhysicalInterface.static_arp_entry()
PhysicalInterface.virtual_engine_vlan_ok
PhysicalInterface.virtual_mapping
PhysicalInterface.virtual_resource_name
- Layer3PhysicalInterface
- Layer2PhysicalInterface
- ClusterPhysicalInterface
- VirtualPhysicalInterface
- SwitchPhysicalInterface
- TunnelInterface
- VPNBrokerInterface
- VlanInterface
- Sub-Interfaces
- InterfaceContactAddress
- InterfaceCollections
- Node
MasterNode
Node
Node.appliance_info()
Node.bind_license()
Node.cancel_unbind_license()
Node.certificate_info()
Node.change_ssh_pwd()
Node.debug()
Node.fetch_license()
Node.go_offline()
Node.go_online()
Node.go_standby()
Node.hardware_status
Node.health
Node.initial_contact()
Node.interface_status
Node.lock_offline()
Node.lock_online()
Node.loopback_interface
Node.nodeid
Node.pki_certificate_info()
Node.pki_certificate_settings()
Node.pki_delete_certificate_request()
Node.pki_export_certificate_request()
Node.pki_import_certificate()
Node.pki_renew_certificate()
Node.power_off()
Node.reboot()
Node.rename()
Node.reset_to_factory()
Node.reset_user_db()
Node.set_debug()
Node.sginfo()
Node.ssh()
Node.status()
Node.time_sync()
Node.type
Node.unbind_license()
Node.version
- Appliance Info
- Appliance Status
- ApplianceSwitchModule
- Hardware Status
- Interface Status
- Debug
- Pending Changes
- Routing
RoutingTree
RoutingTree.all()
RoutingTree.as_tree()
RoutingTree.delete()
RoutingTree.dynamic_nicid
RoutingTree.get()
RoutingTree.ip
RoutingTree.level
RoutingTree.name
RoutingTree.nicid
RoutingTree.probe_ecmp
RoutingTree.probe_interval
RoutingTree.probe_ipaddress
RoutingTree.probe_metric
RoutingTree.probe_retry_count
RoutingTree.probe_test
RoutingTree.related_element_type
RoutingTree.update()
- Routing
- Antispoofing
- Route Table
- Policy Routing
- TunnelMonitoringGroup
- Snapshot
- VirtualResource
- AdvanceSettings
- Engine Types
- Dynamic Routing Elements
- RouteMap
- IPAccessList
- IPPrefixList
- BGP Elements
- OSPF Elements
- Policies
- Sub Policies
- Rules
- Rule
Rule
Rule.action
Rule.authentication_options
Rule.comment
Rule.destinations
Rule.disable()
Rule.enable()
Rule.history
Rule.is_disabled
Rule.is_rule_section
Rule.match_vpn_options
Rule.move_rule_after()
Rule.move_rule_before()
Rule.name
Rule.options
Rule.parent_policy
Rule.save()
Rule.services
Rule.sources
Rule.tag
Rule.update()
- IPv4Rule
- IPv4Layer2Rule
- EthernetRule
- IPv6Rule
- NATRule
- RuleElements
RuleElement
- Source
- Destination
- Service
- Action
Action
Action.antispam
Action.decrypting
Action.deep_inspection
Action.dos_protection
Action.file_filtering
Action.forced_next_hop_element
Action.forced_next_hop_ip
Action.mobile_vpn
Action.network_application_latency_monitoring
Action.scan_detection
Action.sub_policy
Action.user_response
Action.valid_blacklister
Action.valid_block_lister
Action.vpn
- ConnectionTracking
- LogOptions
LogOptions
LogOptions.application_logging
LogOptions.endpoint_executable_logging
LogOptions.log_accounting_info_mode
LogOptions.log_alert
LogOptions.log_closing_mode
LogOptions.log_compression
LogOptions.log_compression_max_burst_size
LogOptions.log_compression_max_log_rate
LogOptions.log_level
LogOptions.log_payload_excerpt
LogOptions.log_payload_record
LogOptions.log_severity
LogOptions.qos_class
LogOptions.url_category_logging
LogOptions.user_logging
- AuthenticationOptions
- MatchExpression
- NATElements
- Rule
- VPN
- PolicyVPN
PolicyVPN
PolicyVPN.add_central_gateway()
PolicyVPN.add_internal_gateway_to_vpn()
PolicyVPN.add_mobile_gateway()
PolicyVPN.add_satellite_gateway()
PolicyVPN.central_gateway_node
PolicyVPN.close()
PolicyVPN.create()
PolicyVPN.enable_disable_nat()
PolicyVPN.mobile_gateway_node
PolicyVPN.mobile_vpn_topology
PolicyVPN.nat
PolicyVPN.open()
PolicyVPN.satellite_gateway_node
PolicyVPN.save()
PolicyVPN.tunnels
PolicyVPN.validate()
- RouteVPN
EndpointTunnel
RouteVPN
RouteVPN.create_geneve_mode()
RouteVPN.create_gre_transport_mode()
RouteVPN.create_gre_tunnel_mode()
RouteVPN.create_gre_tunnel_no_encryption()
RouteVPN.create_ipsec_tunnel()
RouteVPN.disable()
RouteVPN.enable()
RouteVPN.local_endpoint
RouteVPN.remote_endpoint
RouteVPN.set_preshared_key()
RouteVPN.set_tunnel_group()
RouteVPN.tunnel_mode
RouteVPN.tunnels
RouteVPNTunnelMonitoringGroup
TunnelEndpoint
TunnelMonitoringGroup
- Gateways
- VPNSite
- Other Elements
- PolicyVPN
- Collections Reference
- Monitoring
EngineNodeStatus
EngineNodeStatus.active_policy
EngineNodeStatus.active_policy_ref
EngineNodeStatus.configuration_status
EngineNodeStatus.dyn_up
EngineNodeStatus.engine_node_status
EngineNodeStatus.hw_info
EngineNodeStatus.installed_policy_ref
EngineNodeStatus.last_upload_time
EngineNodeStatus.local_alternative_policies
EngineNodeStatus.local_alternative_policy_activation_time
EngineNodeStatus.master_node
EngineNodeStatus.platform
EngineNodeStatus.version
MonitoringStatus
SDWANBranchStatus
SDWANBranchToBranchStatus
SDWANNetlinkElementStatus
ServerStatus
VPNEndpointTunnelStatus
VPNGatewayTunnelStatus
VPNStatus
- Advanced Usage
- Waiters
- Exceptions
ActionCommandFailed
AlertChainError
AlertPolicyError
CertificateError
CertificateExportError
CertificateImportError
ConfigLoadError
CreateElementFailed
CreateEngineFailed
CreatePolicyFailed
CreateRuleFailed
CreateVPNFailed
DeleteElementFailed
EcaClientConfigExportError
ElementNotFound
EngineCommandFailed
FetchElementFailed
HaCommandException
InterfaceNotFound
InvalidLogSeverity
InvalidRuleValue
InvalidSearchFilter
LicenseError
LoadElementFailed
LoadEngineFailed
LoadPolicyFailed
MissingDependency
MissingRequiredInput
ModificationAborted
ModificationFailed
NodeCommandFailed
NotMonitored
PolicyCommandFailed
ResourceNotFound
SMCConnectionError
SMCException
SMCOperationFailure
SessionManagerNotFound
SessionNotFound
TaskRunFailed
UnsupportedAlertChannel
UnsupportedAttribute
UnsupportedEngineFeature
UnsupportedEntryPoint
UnsupportedInterfaceType
UpdateElementFailed
UserElementNotFound