FortiManager Facts

4 min

Resumo

Reúne fatos do FortiManager usando a API jsonrpc

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
adom - required	string		O ADOM ao qual a configuração deve pertencer.
host - required	string		Endereço do FortiManager.
password	string		A senha associada à conta de nome de usuário.
port	integer		A porta TCP usada para conectar ao FortiManager se for diferente do padrão usado pelo método transporte(http=80, https=443).
provider	dict		Dicionário que funciona como uma coleção de argumentos usados para definir a característica de como se conectar ao dispositivo. Os argumentos hostname, username e password devem ser especificados no provedor ou no parâmetro local. Parâmetros locais têm precedência, por ex. hostname é preferível a provider["hostname"] quando ambos são especificados.
session_id	string		O session_id de uma sessão estabelecida e ativa
use_ssl	boolean	Default: true	Determina se deve usar HTTPS(True) ou HTTP(False).
username	string		O nome de usuário usado para autenticar com o FortiManager.
validate_certs	boolean	Escolhas: True False	Determina se deve validar os certificados em um arquivo de certificado confiável (True) ou aceitar todos os certificados (False)
adoms	lista		Uma lista de ADOMs para os quais as configurações do FortiManager serão recuperadas; "all" pode ser usado para recuperar todos os ADOMs. Se "all" for usado ou o valor for uma lista de nomes ADOM (como strings), todos os pacotes para cada ADOM serão recuperados. Passar uma lista de dicionários com as chaves "name" e "package" pode ser usado para limitar o escopo das políticas recuperadas. Um par chave/valor é necessário para cada pacote (os valores do dicionário não podem ser listas). Os objetos e elementos da política serão coletados com base no que está listado no parâmetro config_filter.
config_filter	lista	Escolhas: all route address address_group service service_group ip_pool vip vip_group policy	The list of configuration items to retrieve from the list of ADOMs and FortiGates managed by the FortiManager. This list will only be used if the fortigates or adoms parameters are passed.
fortigate_name	string	Escolhas: device_id hostname	O nome a ser usado como a chave do dicionário de configuração ao retornar os dados de configuração. Isso é usado apenas quando fortigates é tudo ou uma lista de nomes fortigate. C(device_id) usará o ID do dispositivo que o FortiManager associou ao dispositivo. C(hostname) usará o nome do host do dispositivo.
fortigates	lista		Uma lista de FortiGates para recuperar informações do dispositivo; "all" pode ser usado para recuperar todos os dispositivos gerenciados pelo FortiManger. Se config_filter for definido, esta lista será usada para determinar de quais dispositivos recuperar a configuração. Se config_filter for definido, esta lista deve ser uma lista de dicionários com as chaves "name" e "vdom" definindo o mapeamento para fortigate e vdom.

Exemplos

- name: Obtenha fatos
  fortimgr_facts:
    host: "{{ atmosphere_host }}"
    username: "{{ atmosphere_user }}"
    password: "{{ atmosphere_password }}"
    adom: "lab"
- name: Obter FortiGates
  fortimgr_facts:
    host: "{{ atmosphere_host }}"
    username: "{{ atmosphere_user }}"
    password: "{{ atmosphere_password }}"
    adom: "lab"
    fortigates:
      - "lab"
      - "prod"
      - "dmz"
- name: Obter configurações do Fortigate
  fortimgr_facts:
    host: "{{ atmosphere_host }}"
    username: "{{ atmosphere_user }}"
    password: "{{ atmosphere_password }}"
    adom: "lab"
    fortigates:
      - name: "lab"
        vdom: "root"
      - name: "prod"
        vdom: "root"
      - name: "dmz"
        vdom: "web"
      - name: "dmz"
        vdom: "dmz"
    config_filter:
      - "route"
      - "policy"
- name: Obtenha todas as configurações do Fortigate
  fortimgr_facts:
    host: "{{ atmosphere_host }}"
    username: "{{ atmosphere_user }}"
    password: "{{ atmosphere_password }}"
    adom: "lab"
    fortigates: "all"
    config_filter: "all"
- name: Obter configurações do FortiManager
  fortimanager_facts:
    host: "{{ atmosphere_host }}"
    username: "{{ atmosphere_user }}"
    password: "{{ atmosphere_password }}"
    adoms:
      name: "lab"
      package: "lab"
    config_filter: "all"

Valores retornados

Chave	Tipo	Retornado quando	Descrição
fortimanager	dict	Sempre	Informações e status sobre o FortiManager.
devices	dict	Sempre	Informações básicas sobre dispositivos gerenciados pelo FortiManager.
configs	dict	Sempre	A configuração que foi enviada para o FortiManager.
fortimanager_configs	dict	Sempre	As configurações no FortiManager.