Click or drag to resize

Session Class

An active management session. This class handles all communications to the Management server.
Inheritance Hierarchy

Namespace:  Koopman.CheckPoint
Assembly:  CheckPoint.NET (in CheckPoint.NET.dll) Version: 0.5.1
Syntax
C#
public class Session : HttpSession
Request Example View Source

The Session type exposes the following members.

Properties
  NameDescription
Public propertyAPIServerVersion
API Server version.
Public propertyAPIVersion
API version being used.
Public propertyDebugWriter
Gets or sets the debug writer. All API posts and responses will be sent to this writer. They are sent in the RAW JSON format as sent and received to/from the server.
(Inherited from HttpSession.)
Public propertyDetailLevelAction
Gets the action to be taken when current detail level is too low.
Public propertyDiskSpaceMessage
Information about the available disk space on the management server.
Public propertyIndentJson
Gets a value indicating whether JSON data sent to server should be indented. Useful for debugging.
(Inherited from HttpSession.)
Public propertyLastLoginWasAt
Timestamp when administrator last accessed the management server.
Public propertyLoginMessage
Gets the login message.
Public propertyMaxConnections
Gets the max number of connections to management server allowed.
(Inherited from HttpSession.)
Public propertyReadOnly
Session is read only status.
Public propertySessionTimeout
Session expiration timeout in seconds.
Public propertySID
Session unique identifier.
Public propertyStandby
True if this management server is in standby mode.
Public propertyUID
Session object unique identifier.
Public propertyURL
URL that was used to reach the API server.
(Inherited from HttpSession.)
Top
Methods
  NameDescription
Public methodContinueSessionInSmartconsole
Logout of session and continue the session in smartconsole.
Public methodDeleteAccessLayer
Deletes an access layer.
Public methodDeleteAddressRange
Deletes an address range.
Public methodDeleteApplicationCategory
Deletes an application category.
Public methodDeleteApplicationGroup
Deletes an application group.
Public methodDeleteApplicationSite
Deletes an application site.
Public methodDeleteGroup
Deletes a group.
Public methodDeleteGroupWithExclusion
Deletes a group with exclusion.
Public methodDeleteHost
Deletes a host.
Public methodDeleteMulticastAddressRange
Deletes a multicast address range.
Public methodDeleteNetwork
Deletes a network.
Public methodDeleteSecurityZone
Deletes a security zone.
Public methodDeleteServiceDceRpc
Deletes a DCE-RPC service.
Public methodDeleteServiceGroup
Deletes a service group.
Public methodDeleteServiceICMP
Deletes a service-icmp.
Public methodDeleteServiceICMP6
Deletes a service-icmp6.
Public methodDeleteServiceOther
Deletes a other service.
Public methodDeleteServiceRPC
Deletes a RPC service.
Public methodDeleteServiceSCTP
Deletes a SCTP service.
Public methodDeleteServiceTCP
Deletes a TCP service.
Public methodDeleteServiceUDP
Deletes a UDP service.
Public methodDeleteSimpleGateway
Deletes a simple gateway.
Public methodDeleteTag
Deletes a tag.
Public methodDeleteTime
Deletes a time object.
Public methodDeleteTimeGroup
Deletes a time group.
Public methodDiscard
Discard changes made in session.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodFindAccessLayer
Finds an access layer.
Public methodFindAccessLayers(DetailLevels, Int32, Int32, IOrder, CancellationToken)
Finds access layers.
Public methodFindAccessLayers(String, Boolean, DetailLevels, Int32, Int32, IOrder, CancellationToken)
Finds access layers that match filter.
Public methodFindAccessRule
Finds the access rule by rule number.
Public methodFindAccessRulebase
Finds the access rule base.
Public methodFindAddressRange
Finds an address range.
Public methodFindAddressRanges(DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds address ranges.
Public methodFindAddressRanges(String, Boolean, DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds address ranges that match filter.
Public methodFindAllAccessLayers(DetailLevels, Int32, IOrder, CancellationToken)
Finds all access layers.
Public methodFindAllAccessLayers(String, Boolean, DetailLevels, Int32, IOrder, CancellationToken)
Finds all access layers that match filter.
Public methodFindAllAccessRulebase
Finds the access rule base.
Public methodFindAllAddressRanges(DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all address ranges.
Public methodFindAllAddressRanges(String, Boolean, DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all address ranges that match filter.
Public methodFindAllApplicationCategories(DetailLevels, Int32, IOrder, CancellationToken)
Finds all application categories.
Public methodFindAllApplicationCategories(String, Boolean, DetailLevels, Int32, IOrder, CancellationToken)
Finds all application categories that match filter.
Public methodFindAllApplicationGroups(DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all application groups.
Public methodFindAllApplicationGroups(String, Boolean, DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all application groups that match filter.
Public methodFindAllApplicationSites(DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all application sites.
Public methodFindAllApplicationSites(String, Boolean, DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all application sites that match filter.
Public methodFindAllGroups(DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all groups.
Public methodFindAllGroups(String, Boolean, DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all groups that match filter.
Public methodFindAllGroupsWithExclusion(DetailLevels, Int32, IOrder, CancellationToken)
Finds all groups with exclusion.
Public methodFindAllGroupsWithExclusion(String, Boolean, DetailLevels, Int32, IOrder, CancellationToken)
Finds all groups with exclusion that match filter.
Public methodFindAllHosts(DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all hosts.
Public methodFindAllHosts(String, Boolean, DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all hosts that match filter.
Public methodFindAllMulticastAddressRanges(DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all multicast address ranges.
Public methodFindAllMulticastAddressRanges(String, Boolean, DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all multicast address ranges that match filter.
Public methodFindAllNetworks(DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all networks.
Public methodFindAllNetworks(String, Boolean, DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all networks that match filter.
Public methodFindAllObjects
Finds all objects that match filter.
Public methodFindAllSecurityZones(DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all security zones.
Public methodFindAllSecurityZones(String, Boolean, DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all security zones that match filter.
Public methodFindAllServiceGroups(DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all service groups.
Public methodFindAllServiceGroups(String, Boolean, DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all service groups that match filter.
Public methodFindAllServicesDceRpc(DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all DCE-RPC services.
Public methodFindAllServicesDceRpc(String, Boolean, DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all DCE-RPC services that match filter.
Public methodFindAllServicesICMP(DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all services ICMP.
Public methodFindAllServicesICMP(String, Boolean, DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all service-icmps that match filter.
Public methodFindAllServicesICMP6(DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all services ICMP6.
Public methodFindAllServicesICMP6(String, Boolean, DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all service-icmp6s that match filter.
Public methodFindAllServicesOther(DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all other services.
Public methodFindAllServicesOther(String, Boolean, DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all other services that match filter.
Public methodFindAllServicesRPC(DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all RPC services.
Public methodFindAllServicesRPC(String, Boolean, DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all RPC services that match filter.
Public methodFindAllServicesSCTP(DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all SCTP services.
Public methodFindAllServicesSCTP(String, Boolean, DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all SCTP services that match filter.
Public methodFindAllServicesTCP(DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all TCP services.
Public methodFindAllServicesTCP(String, Boolean, DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all TCP services that match filter.
Public methodFindAllServicesUDP(DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all UDP services.
Public methodFindAllServicesUDP(String, Boolean, DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all UDP services that match filter.
Public methodFindAllSessions
Finds all sessions.
Public methodFindAllSimpleGateways(DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all simple gateways.
Public methodFindAllSimpleGateways(String, Boolean, DetailLevels, Int32, IOrder, Boolean, CancellationToken)
Finds all simple gateways that match filter.
Public methodFindAllTags(DetailLevels, Int32, IOrder, CancellationToken)
Finds all tags.
Public methodFindAllTags(String, Boolean, DetailLevels, Int32, IOrder, CancellationToken)
Finds all tags that match filter.
Public methodFindAllTimeGroups(DetailLevels, Int32, IOrder, CancellationToken)
Finds all time groups.
Public methodFindAllTimeGroups(String, Boolean, DetailLevels, Int32, IOrder, CancellationToken)
Finds all time groups that match filter.
Public methodFindAllTimes(DetailLevels, Int32, IOrder, CancellationToken)
Finds all time objects.
Public methodFindAllTimes(String, Boolean, DetailLevels, Int32, IOrder, CancellationToken)
Finds all time objects that match filter.
Public methodFindAllUnusedObjects
Searches for unusage objects.
Public methodFindApplicationCategories(DetailLevels, Int32, Int32, IOrder, CancellationToken)
Finds application categories.
Public methodFindApplicationCategories(String, Boolean, DetailLevels, Int32, Int32, IOrder, CancellationToken)
Finds application categories that match filter.
Public methodFindApplicationCategory
Finds an application category.
Public methodFindApplicationGroup
Finds an application group.
Public methodFindApplicationGroups(DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds application groups.
Public methodFindApplicationGroups(String, Boolean, DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds application groups that match filter.
Public methodFindApplicationSite(Int32, DetailLevels, CancellationToken)
Finds an application site.
Public methodFindApplicationSite(String, DetailLevels, CancellationToken)
Finds an application site.
Public methodFindApplicationSites(DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds application sites.
Public methodFindApplicationSites(String, Boolean, DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds application sites that match filter.
Public methodFindGroup
Finds a group.
Public methodFindGroups(DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds groups.
Public methodFindGroups(String, Boolean, DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds groups that match filter.
Public methodFindGroupsWithExclusion(DetailLevels, Int32, Int32, IOrder, CancellationToken)
Finds groups with exclusion.
Public methodFindGroupsWithExclusion(String, Boolean, DetailLevels, Int32, Int32, IOrder, CancellationToken)
Finds groups with exclusion that match filter.
Public methodFindGroupWithExclusion
Finds a group with exclusion.
Public methodFindHost
Finds a host.
Public methodFindHosts(DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds hosts.
Public methodFindHosts(String, Boolean, DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds hosts that match filter.
Public methodFindMulticastAddressRange
Finds a multicast address range.
Public methodFindMulticastAddressRanges(DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds multicast address ranges.
Public methodFindMulticastAddressRanges(String, Boolean, DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds multicast address ranges that match filter.
Public methodFindNetwork
Finds a network.
Public methodFindNetworks(DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds networks.
Public methodFindNetworks(String, Boolean, DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds networks that match filter.
Public methodFindObject
Finds an object by UID.
Public methodFindObjects
Finds objects that match filter.
Public methodFindSecurityZone
Finds a security zone.
Public methodFindSecurityZones(DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds security zones.
Public methodFindSecurityZones(String, Boolean, DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds security zones that match filter.
Public methodFindServiceDceRpc
Finds a DCE-RPC service.
Public methodFindServiceGroup
Finds a service group.
Public methodFindServiceGroups(DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds service groups.
Public methodFindServiceGroups(String, Boolean, DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds service groups that match filter.
Public methodFindServiceICMP
Finds a service-icmp.
Public methodFindServiceICMP6
Finds a service-icmp6.
Public methodFindServiceOther
Finds a other service.
Public methodFindServiceRPC
Finds a RPC service.
Public methodFindServiceSCTP
Finds a SCTP service.
Public methodFindServicesDceRpc(DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds DCE-RPC services.
Public methodFindServicesDceRpc(String, Boolean, DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds DCE-RPC services that match filter.
Public methodFindServicesICMP(DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds services ICMP.
Public methodFindServicesICMP(String, Boolean, DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds service-icmps that match filter.
Public methodFindServicesICMP6(DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds services ICMP6.
Public methodFindServicesICMP6(String, Boolean, DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds service-icmp6s that match filter.
Public methodFindServicesOther(DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds other services.
Public methodFindServicesOther(String, Boolean, DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds other services that match filter.
Public methodFindServicesRPC(DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds RPC services.
Public methodFindServicesRPC(String, Boolean, DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds RPC services that match filter.
Public methodFindServicesSCTP(DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds SCTP services.
Public methodFindServicesSCTP(String, Boolean, DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds SCTP services that match filter.
Public methodFindServicesTCP(DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds TCP services.
Public methodFindServicesTCP(String, Boolean, DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds TCP services that match filter.
Public methodFindServicesUDP(DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds UDP services.
Public methodFindServicesUDP(String, Boolean, DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds UDP services that match filter.
Public methodFindServiceTCP
Finds a TCP service.
Public methodFindServiceUDP
Finds a UDP service.
Public methodFindSession
Finds a session.
Public methodFindSessions
Finds sessions.
Public methodFindSimpleGateway
Finds a simple gateway.
Public methodFindSimpleGateways(DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds simple gateways.
Public methodFindSimpleGateways(String, Boolean, DetailLevels, Int32, Int32, IOrder, Boolean, CancellationToken)
Finds simple gateways that match filter.
Public methodFindTag
Finds a tag.
Public methodFindTags(DetailLevels, Int32, Int32, IOrder, CancellationToken)
Finds tags.
Public methodFindTags(String, Boolean, DetailLevels, Int32, Int32, IOrder, CancellationToken)
Finds tags that match filter.
Public methodFindTask
Find a task.
Public methodFindTime
Finds a time object.
Public methodFindTimeGroup
Finds a time group.
Public methodFindTimeGroups(DetailLevels, Int32, Int32, IOrder, CancellationToken)
Finds time groups.
Public methodFindTimeGroups(String, Boolean, DetailLevels, Int32, Int32, IOrder, CancellationToken)
Finds time groups that match filter.
Public methodFindTimes(DetailLevels, Int32, Int32, IOrder, CancellationToken)
Finds time objects.
Public methodFindTimes(String, Boolean, DetailLevels, Int32, Int32, IOrder, CancellationToken)
Finds time objects that match filter.
Public methodFindUnusedObjects
Searches for unused objects.
Public methodFindWhereUsed
Searches for usage of the target object in other objects and rules.
Public methodFindWhereUsedCustom
Searches for usage of the target object in other objects and rules. Unlike , this method only makes indirect calls to the management server. It then follows only the object types defined in indirectTypes. This addresses the problem where the normal where-used can follow objects you may not wish to follow.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLoginMessage
Gets the login message.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInstallPolicy
Installs the policy to gateways.
Public methodStatic memberLogin
Logins the specified management server, creating a new session.
Public methodLogout
Logout of this instance. Also disposes this current session object.
Public methodPostAsync
Async posts the specified command with the JSON data supplied. This can be used to send any commands this .NET package doesn't implement yet.
(Inherited from HttpSession.)
Public methodPublish
Publishes the session.
Public methodRunScript(String, String, String, String, String, CancellationToken)
Runs the script on a single target.
Public methodRunScript(String, String, String, String, String, CancellationToken)
Runs the script on multiple targets.
Public methodSendKeepAlive
Sends the keep alive.
Public methodSetLoginMessage
Sets the login message. All null values will not be changed.
Public methodSetSessionInfo
Edit user's current session. All null values will not be changed.
Public methodSwitchSession
Switch to another session.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodVerifyPolicy
Verifies the policy.
Top
Extension Methods
  NameDescription
Public Extension MethodUpdateAccessLayer
Updates the Access Layer without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateAddressRange
Updates the Address Range without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateApplicationCategory
Updates the Application Category without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateApplicationGroup
Updates the Application Group without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateApplicationSite
Updates the Application Site without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateGroup
Updates the Group without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateGroupWithExclusion
Updates the Group With Exclusion without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateHost
Updates the host without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateMulticastAddressRange
Updates the Multicast Address Range without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateNetwork
Updates the Network without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateSecurityZone
Updates the Security Zone without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateServiceDceRpc
Updates the Service DCE-RPC without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateServiceGroup
Updates the Service Group without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateServiceICMP
Updates the Service ICMP without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateServiceICMP6
Updates the Service ICMP6 without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateServiceOther
Updates the Service Other without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateServiceRPC
Updates the Service RPC without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateServiceSCTP
Updates the Service SCTP without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateServiceTCP
Updates the Service TCP without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateServiceUDP
Updates the Service UDP without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateSimpleGateway
Updates the Simple Gateway without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateTag
Updates the Tag without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateTime
Updates the Time without finding it first.
(Defined by FastUpdate.)
Public Extension MethodUpdateTimeGroup
Updates the Time Group without finding it first.
(Defined by FastUpdate.)
Top
Examples
var session = Session.Login(
managementServer: "192.168.1.1",
userName: "admin",
password: "***",
certificateValidation: false
);
See Also