CP MGMT host

8 min

Sinopse

Gerencia objetos de host em dispositivos Check Point, incluindo criação, atualização e remoção de objetos.
Todas as operações são realizadas pela API de serviços Web.

Parâmetros

Parâmetro	Tipo	Escolhas	Descrição
auto_publish_session	booleano	false (padrão), true	Publica a sessão atual se alterações forem feitas após a conclusão da tarefa.
color	string	"aquamarine", "black", "blue", "crete blue", "burlywood", "cyan", "dark green", "khaki", "orchid", "dark orange", "dark sea green", "pink", "turquoise", "dark blue", "firebrick", "brown", "forest green", "gold", "dark gold", "gray", "dark gray", "light green", "lemon chiffon", "coral", "sea green", "sky blue", "magenta", "purple", "slate blue", "violet red", "navy blue", "olive", "orange", "red", "sienna", "yellow"	Cor do objeto. Deve ser uma das cores existentes.
comments	string		String de comentários.
details_level	string	"uid", "standard", "full"	O nível de detalhe para alguns dos campos na resposta pode variar de mostrar apenas o valor UID do objeto a uma representação totalmente detalhada do objeto.
groups	lista de strings		Coleção de identificadores de grupo.
host_servers	dicionário	Ver sub-tabela host_servers	Configurações do servidor.
ignore_errors	booleano	false, true	Aplica as alterações ignorando erros. Você não poderá publicar tais alterações. Se o sinalizador ignore-warnings for omitido, os avisos também serão ignorados.
ignore_warnings	booleano	false, true	Aplica as alterações ignorando avisos.
interfaces	lista de dicionários	Ver sub-tabela interfaces	Interfaces do host.
ip_address	string		Endereço IPv4 ou IPv6.
ipv4_address	string		Endereço IPv4.
ipv6_address	string		Endereço IPv6.
name	string		Nome do objeto.
nat_settings	dicionário	Ver sub-tabela nat_settings	Configurações de NAT (Network Address Translation).
state	string	"present" (padrão), "absent"	Estado da regra de acesso (presente ou ausente).
tags	lista de strings		Coleção de identificadores de tag.
version	string		Versão do checkpoint. Se não for dada, a última versão será usada.
wait_for_task	booleano	false, true (padrão)	Aguarda o término da tarefa, como a tarefa de publicação.
wait_for_task_timeout	inteiro	30 (padrão)	Quantos minutos esperar antes de lançar um erro de tempo limite.

Sub-tabela: host_servers

Parâmetro	Tipo	Escolhas	Descrição
dns_server	booleano	false, true	Indica se este servidor é um servidor DNS.
mail_server	booleano	false, true	Indica se este servidor é um servidor de e-mail.
web_server	booleano	false, true	Indica se este servidor é um servidor Web.
web_server_config	dicionário	Ver sub-tabela web_server_config	Configuração do servidor Web.

Sub-tabela: web_server_config

Parâmetro	Tipo	Escolhas	Descrição
additional_ports	lista de strings		Portas adicionais do servidor.
application_engines	lista de strings		Mecanismos de aplicação deste servidor Web.
listen_standard_port	booleano	false, true	Indica se o servidor escuta na porta padrão.
operating_system	string	"sparc linux", "windows", "other", "x86 linux", "sparc solaris"	Sistema operacional.
protected_by	string		Objeto de rede que protege este servidor identificado pelo nome ou UID.

Sub-tabela: interfaces

Parâmetro	Tipo	Escolhas	Descrição
color	string	"aquamarine", "black", "blue", "crete blue", "burlywood", "cyan", "dark green", "khaki", "orchid", "dark orange", "dark sea green", "pink", "turquoise", "dark blue", "firebrick", "brown", "forest green", "gold", "dark gold", "gray", "dark gray", "light green", "lemon chiffon", "coral", "sea green", "sky blue", "magenta", "purple", "slate blue", "violet red", "navy blue", "olive", "orange", "red", "sienna", "yellow"	Cor do objeto. Deve ser uma das cores existentes.
comments	string		String de comentários.
details_level	string	"uid", "standard", "full"	O nível de detalhe para alguns dos campos na resposta pode variar.
ignore_errors	booleano	false, true	Aplica as alterações ignorando erros.
ignore_warnings	booleano	false, true	Aplica as alterações ignorando avisos.
mask_length	inteiro		Comprimento da máscara de rede IPv4 ou IPv6.
mask_length4	inteiro		Comprimento da máscara de rede IPv4.
mask_length6	inteiro		Comprimento da máscara de rede IPv6.
name	string		Nome da interface.
subnet	string		Endereço de rede IPv4 ou IPv6.
subnet4	string		Endereço de rede IPv4.
subnet6	string		Endereço de rede IPv6.
subnet_mask	string		Máscara de rede IPv4.

Sub-tabela: nat_settings

Parâmetro	Tipo	Escolhas	Descrição
auto_rule	booleano	false, true	Indica se deve adicionar regras automáticas
hide_behind	string	gateway, ip-address	Ocultar atrás do método. Este parâmetro não é necessário caso o parâmetro “method” seja “static”.
install_on	string		Qual gateway deve aplicar a tradução NAT.
ip_address	string		Endereço IPv4 ou IPv6. Se ambos os endereços forem necessários, use os campos ipv4-address e ipv6-address explicitamente. Este parâmetro não é necessário caso o parâmetro “method” seja “hide” e o parâmetro “hide-behind” seja “gateway”.
ipv4_address	string		Endereço IPv4.
ipv6_address	string		Endereço IPv6.
method	string		Método de tradução NAT.

Exemplos

- name: add-host cp_mgmt_host: ip_address: 192.0.2.1 name: New Host 1 state: present - name: set-host cp_mgmt_host: color: green ipv4_address: 192.0.2.2 name: New Host 1 state: present - name: delete-host cp_mgmt_host: name: New Host 1 state: absent

Valores retornados

Os valores de retorno comuns são documentados aqui . Os seguintes são os campos exclusivos deste módulo:

Chave	Tipo	Retornado quando	Descrição
cp_mgmt_host	dict	O objeto de ponto de verificação foi criado ou atualizado.	O objeto de ponto de verificação foi criado ou atualizado.