NAME
Net::Checkpoint::Management::v1 - Checkpoint Management API version 1.x client library
VERSION
version 0.004002
SYNOPSIS
use strict;
use warnings;
use Net::Checkpoint::Management::v1;
my $cpmgmt = Net::Checkpoint::Management::v1->new(
server => 'https://cpmgmt.example.com',
user => 'username',
passwd => '$password',
clientattrs => { timeout => 30 },
);
$cpmgmt->login;
# OR
$cpmgmt = Net::Checkpoint::Management::v1->new(
server => 'https://cpmgmt.example.com',
api_key => '$api-key',
clientattrs => { timeout => 30 },
);
$cpmgmt->login;DESCRIPTION
This module is a client library for the Checkpoint Management API version 1.x. Currently it is developed and tested against version R81.20.
ATTRIBUTES
This module is using Role::REST::Client under the hood and all its attributes can be set too.
user
Sets the username used by the "login" method.
passwd
Sets the password used by the "login" method.
api_key
Sets the API key used by the "login" method.
api_versions
Returns a list of all available API versions which gets populated on the first call. Only works on API version 1.1 and higher.
api_version
The API version used by all methods. Is automatically set to the highest version available by the "login" method.
METHODS
create_package
Creates a package, see "create_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
list_packages
Lists packages, see "list_$object" in Net::Checkpoint::Management::v1::Role::ObjectMethods
find_package
Finds a package, see "find_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
get_package
Gets a package, see "get_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
update_package
Updates a package, see "update_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
delete_package
Deletes a package, see "delete_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
create_accessrule
Creates an accessrule, see "create_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
list_accessrules
Lists accessrules, see "list_$object" in Net::Checkpoint::Management::v1::Role::ObjectMethods
find_accessrule
Finds an accessrule, see "find_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
get_accessrule
Gets an accessrule, see "get_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
update_accessrule
Updates an accessrule, see "update_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
delete_accessrule
Deletes an accessrule, see "delete_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
create_network
Creates a network, see "create_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
list_networks
Lists networks, see "list_$object" in Net::Checkpoint::Management::v1::Role::ObjectMethods
find_network
Finds a network, see "find_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
get_network
Gets a network, see "get_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
update_network
Updates a network, see "update_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
delete_network
Deletes a network, see "delete_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
create_host
Creates a host, see "create_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
list_hosts
Lists hosts, see "list_$object" in Net::Checkpoint::Management::v1::Role::ObjectMethods
find_host
Finds a host, see "find_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
get_host
Gets a host, see "get_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
update_host
Updates a host, see "update_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
delete_host
Deletes a host, see "delete_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
create_address_range
Creates an address_range, see "create_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
list_address_ranges
Lists address_ranges, see "list_$object" in Net::Checkpoint::Management::v1::Role::ObjectMethods
find_address_range
Finds an address_range, see "find_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
get_address_range
Gets an address_range, see "get_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
update_address_range
Updates an address_range, see "update_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
delete_address_range
Deletes an address_range, see "delete_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
create_dns_domain
Creates a dns_domain, see "create_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
list_dns_domains
Lists dns_domains, see "list_$object" in Net::Checkpoint::Management::v1::Role::ObjectMethods
find_dns_domain
Finds a dns_domain, see "find_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
get_dns_domain
Gets a dns_domain, see "get_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
update_dns_domain
Updates a dns_domain, see "update_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
delete_dns_domain
Deletes a dns_domain, see "delete_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
create_group
Creates a group, see "create_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
list_groups
Lists groups, see "list_$object" in Net::Checkpoint::Management::v1::Role::ObjectMethods
find_group
Finds a group, see "find_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
get_group
Gets a group, see "get_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
update_group
Updates a group, see "update_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
delete_group
Deletes a group, see "delete_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
create_access_role
Creates an access_role, see "create_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
list_access_roles
Lists access_roles, see "list_$object" in Net::Checkpoint::Management::v1::Role::ObjectMethods
find_access_role
Finds an access_role, see "find_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
get_access_role
Gets an access_role, see "get_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
update_access_role
Updates an access_role, see "update_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
delete_access_role
Deletes an access_role, see "delete_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
create_service_tcp
Creates a service_tcp, see "create_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
list_services_tcp
Lists services_tcp, see "list_$object" in Net::Checkpoint::Management::v1::Role::ObjectMethods
find_service_tcp
Finds a service_tcp, see "find_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
get_service_tcp
Gets a service_tcp, see "get_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
update_service_tcp
Updates a service_tcp, see "update_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
delete_service_tcp
Deletes a service_tcp, see "delete_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
create_service_udp
Creates a service_udp, see "create_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
list_services_udp
Lists services_udp, see "list_$object" in Net::Checkpoint::Management::v1::Role::ObjectMethods
find_service_udp
Finds a service_udp, see "find_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
get_service_udp
Gets a service_udp, see "get_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
update_service_udp
Updates a service_udp, see "update_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
delete_service_udp
Deletes a service_udp, see "delete_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
create_service_icmp
Creates a service_icmp, see "create_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
list_services_icmp
Lists services_icmp, see "list_$object" in Net::Checkpoint::Management::v1::Role::ObjectMethods
find_service_icmp
Finds a service_icmp, see "find_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
get_service_icmp
Gets a service_icmp, see "get_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
update_service_icmp
Updates a service_icmp, see "update_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
delete_service_icmp
Deletes a service_icmp, see "delete_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
create_service_icmpv6
Creates a service_icmpv6, see "create_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
list_services_icmpv6
Lists services_icmpv6, see "list_$object" in Net::Checkpoint::Management::v1::Role::ObjectMethods
find_service_icmpv6
Finds a service_icmpv6, see "find_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
get_service_icmpv6
Gets a service_icmpv6, see "get_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
update_service_icmpv6
Updates a service_icmpv6, see "update_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
delete_service_icmpv6
Deletes a service_icmpv6, see "delete_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
create_service_other
Creates a service_other, see "create_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
list_services_other
Lists services_other, see "list_$object" in Net::Checkpoint::Management::v1::Role::ObjectMethods
find_service_other
Finds a service_other, see "find_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
get_service_other
Gets a service_other, see "get_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
update_service_other
Updates a service_other, see "update_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
delete_service_other
Deletes a service_other, see "delete_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
create_service_group
Creates a service_group, see "create_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
list_service_groups
Lists service_groups, see "list_$object" in Net::Checkpoint::Management::v1::Role::ObjectMethods
find_service_group
Finds a service_group, see "find_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
get_service_group
Gets a service_group, see "get_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
update_service_group
Updates a service_group, see "update_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
delete_service_group
Deletes a service_group, see "delete_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
list_sessions
Lists sessions, see "list_$object" in Net::Checkpoint::Management::v1::Role::ObjectMethods
find_session
Finds a session, see "find_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
get_session
Gets a session, see "get_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
update_session
Updates a session, see "update_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
list_tasks
Lists tasks, see "list_$object" in Net::Checkpoint::Management::v1::Role::ObjectMethods
find_task
Finds a task, see "find_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
get_task
Gets a task, see "get_$singular" in Net::Checkpoint::Management::v1::Role::ObjectMethods
login
Logs into the Checkpoint Manager API using version 1.
If both the "api_key", "user" and "passwd" are set, the "api_key" is used.
Takes an optional hashref of login parameters like read-only or domain.
logout
Logs out of the Checkpoint Manager API using version 1.
publish
Publishes all previously submitted changes. Returns the task id on success.
discard
Discards all previously submitted changes. Returns a hashref containing the operation status message and the number of discarded changes.
verify_policy
Verifies the policy of the given package.
Takes a policy name.
Returns the task id on success.
install_policy
Installs the policy of the given package onto the given target(s).
Takes a policy name, target(s) and an optional hashref of additional parameters. The target(s) can be a single name or uid or a list of names or uids.
Returns the task id on success.
wait_for_task
Takes a task id and checks its status every second until it isn't 'in progress' any more and return the status. Takes an optional callback coderef which is called for every check with the task as argument.
where_used
Takes a Checkpoint object in form of a hashref as returned by the various APIs and optional query parameters.
Prefers the object uid over its name for the query.
Returns the unmodified response on success.
AUTHOR
Alexander Hartmaier <abraxxa@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2019 by Alexander Hartmaier.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.