CP MGMT VPN community star
Resumo
- Gerencia objetos vpn-community-star 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 | boolean | false (padrão), true | Publica a sessão atual se alterações forem realizadas após a conclusão da tarefa. |
center_gateways | list / elements=string | | Coleção de objetos Gateway VPN central e Dispositivo VPN identificados pelo nome ou UID. |
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, mostrando apenas o valor UID do objeto até uma representação completa do objeto. |
encryption_method | string | "prefer ikev2 but support ikev1", "ikev2 only", "ikev1 for ipv4 and ikev2 for ipv6 only" | O método de criptografia a ser usado. |
encryption_suite | string | "suite-b-gcm-256", "custom", "vpn b", "vpn a", "suite-b-gcm-128" | O conjunto de criptografia a ser usado. |
granular_encryptions | list / elements=dictionary | | Configurações de criptografia granular VPN. |
ignore_errors | boolean | false, true | Aplica 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 | boolean | false, true | Aplica alterações ignorando avisos. |
ike_phase_1 | dictionary | | Configurações da Fase 1 do IKE. Aplicável apenas quando o encryption-suite está definido como [custom]. |
ike_phase_2 | dictionary | | Configurações da Fase 2 do IKE. Aplicável apenas quando o encryption-suite está definido como [custom]. |
mesh_center_gateways | boolean | false, true | Indica se a comunidade em malha está no centro. |
name | string / required | | Nome do objeto. |
override_vpn_domains | list / elements=dictionary | | Substitui os Domínios VPN dos GW dos participantes. |
satellite_gateways | list / elements=string | | Coleção de objetos Gateway representando gateways satélite identificados pelo nome ou UID. |
shared_secrets | list / elements=dictionary | | Segredos compartilhados para gateways externos. |
state | string | "present" (padrão), "absent" | Estado da regra de acesso (presente ou ausente). |
tags | list / elements=string | | Coleção de identificadores de tag. |
tunnel_granularity | string | "per_host", "per_subnet", "universal" | Opção de compartilhamento de túnel VPN a ser usada. |
use_shared_secret | boolean | false, true | Indica se o segredo compartilhado deve ser usado para todos os gateways externos. |
version | string | | Versão do Checkpoint. Se não for fornecida, a versão mais recente será usada. |
wait_for_task | boolean | false, true (padrão) | Aguarda o término da tarefa. Como a tarefa de publicação. |
wait_for_task_timeout | integer | 30 (padrão) | Quantos minutos esperar até lançar um erro de tempo limite. |
Sub-tabelas
Tabela Filha 1: granular_encryptions
Parâmetro | Tipo | Escolhas | Descrição |
|---|---|---|---|
encryption_method | string | "prefer ikev2 but support ikev1", "ikev2 only", "ikev1 for ipv4 and ikev2 for ipv6 only" | O método de criptografia a ser usado. |
encryption_suite | string | "suite-b-gcm-256", "custom", "vpn b", "vpn a", "suite-b-gcm-128" | O conjunto de criptografia a ser usado. |
external_gateway | string | | Gateway gerenciado externamente ou de terceiros identificado por nome ou UID. |
ike_phase_1 | dictionary | | Configurações da Fase 1 do Ike. Aplicável somente quando o conjunto de criptografia estiver definido como [personalizado]. |
ike_fase_2 | dictionary | | Configurações da Fase 2 do Ike. Aplicável somente quando o conjunto de criptografia estiver definido como [personalizado]. |
internal_gateway | boolean | false, true | Indica se o Perfect Forward Secrecy (PFS) está sendo usado para a fase 2 do IKE. |
Tabela Filha 2: ike_phase_1
Parâmetro | Tipo | Escolhas | Descrição |
|---|---|---|---|
data_integrity | string | "aes-xcbc", "sha1", "sha256", "sha384", "sha512", "md5" | O algoritmo hash a ser usado. |
diffie_hellman_group | string | "group-1", "group-2", "group-5", "group-14", "group-15", "group-16", "group-17", "group-18", "group-19", "group-20", "group-24" | O grupo Diffie-Hellman a ser usado. |
encryption_algorithm | string | "cast", "aes-256", "des", "aes-128", "3des" | O algoritmo de criptografia a ser usado. |
ike_p1_rekey_time | integer | | Indica o intervalo de tempo para a renegociação da fase 1 do IKE. |
ike_p1_rekey_time_unit | string | "days", "hours", "minutes", "seconds" | Indica a unidade de tempo para o parâmetro [ike-p1-rekey-time-unit], arredondado para a escala de minutos. |
Tabela Filha 3: ike_phase_2
Parâmetro | Tipo | Escolhas | Descrição |
|---|---|---|---|
data_integrity | string | "aes-xcbc", "sha1", "sha256", "sha384", "sha512", "md5" | O algoritmo hash a ser usado. |
encryption_algorithm | string | "cast", "aes-gcm-256", "cast-40", "aes-256", "des", "aes-128", "3des", "des-40cp", "aes-gcm-128", "none" | O algoritmo de criptografia a ser usado. |
ike_p2_pfs_dh_grp | string | "group-1", "group-2", "group-5", "group-14", "group-15", "group-16", "group-17", "group-18", "group-19", "group-20", "group-24" | O grupo Diffie-Hellman a ser usado. |
ike_p2_rekey_time | integer | | Indica o intervalo de tempo para a renegociação da fase 2 do IKE. |
ike_p2_rekey_time_unit | string | "days", "hours", "minutes", "seconds" | Indica a unidade de tempo para o parâmetro [ike-p2-rekey-time-unit]. |
ike_p2_use_pfs | boolean | false, true | Indica se o Perfect Forward Secrecy (PFS) está sendo usado para a fase 2 do IKE. |
Tabela Filha 4: override_vpn_domains
Parâmetro | Tipo | Escolhas | Descrição |
|---|---|---|---|
gateway | string | | Gateway participante na substituição do domínio VPN identificado pelo nome ou UID. |
vpn_domain | string | | Rede de domínio VPN identificada pelo nome ou UID. |
Tabela Filha 5: shared_secrets
Parâmetro | Tipo | Escolhas | Descrição |
|---|---|---|---|
external_gateway | string | | Gateway externo identificado pelo nome ou UID. |
shared_secret | string | | Segredo compartilhado. |
Exemplos
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_vpn_community_star | dict | sempre, exceto ao excluir o objeto. | O objeto de ponto de verificação foi criado ou atualizado. |