Dell-Networking.dellos-snmp
Rôle SNMP
Ce rôle facilite la configuration des attributs globaux SNMP. Il prend en charge la configuration des attributs du serveur SNMP, y compris les utilisateurs, le groupe, la communauté, la localisation et les traps. Ce rôle est abstrait pour dellos9, dellos6 et dellos10.
Le rôle SNMP nécessite une connexion SSH pour se connecter à un appareil de mise en réseau Dell EMC. Vous pouvez utiliser n'importe quelle variable de connexion intégrée au système d'exploitation.
Installation
ansible-galaxy install Dell-Networking.dellos-snmp
Variables du rôle
- Le rôle est abstrait en utilisant la variable ansible_network_os qui peut prendre les valeurs dellos9, dellos6 et dellos10.
- Si dellos_cfg_generate est défini sur true, la variable génère les commandes de configuration du rôle dans un fichier.
- Toute variable de rôle avec une variable d'état correspondante définie sur absent annule la configuration de cette variable.
- Définir une valeur vide pour une variable annule la configuration correspondante.
- Les variables et les valeurs sont sensibles à la casse.
Clés dellos_snmp
Clé | Type | Description | Support |
---|---|---|---|
snmp_contact |
chaîne | Configure les informations de contact SNMP | dellos6, dellos9, dellos10 |
snmp_server_vrf |
booléen: vrai, faux* | Active le VRF du serveur SNMP globalement | dellos9 |
snmp_location |
chaîne | Configure les informations de localisation SNMP | dellos6, dellos9, dellos10 |
snmp_community |
liste | Configure les informations de communauté SNMP (voir snmp_community.* ) |
dellos6, dellos9, dellos10 |
snmp_community.name |
chaîne (obligatoire) | Configure la chaîne de communauté SNMP | dellos6, dellos9, dellos10 |
snmp_community.access_mode |
chaîne: ro,rw | Configure le mode d'accès pour la communauté | dellos6, dellos9, dellos10 |
snmp_community.state |
chaîne: absent, présent* | Supprime les informations de communauté SNMP si défini sur absent | dellos6, dellos9, dellos10 |
snmp_host |
liste | Configure les hôtes SNMP pour recevoir les traps SNMP (voir snmp_host.* ) |
dellos6, dellos9, dellos10 |
snmp_host.ip |
chaîne | Configure l'adresse IP de l'hôte de trap SNMP | dellos6, dellos10 |
snmp_host.ipv4 |
chaîne | Configure l'adresse IPv4 pour l'hôte de trap SNMP | dellos9 |
snmp_host.ipv6 |
chaîne | Configure l'adresse IPv6 pour l'hôte de trap SNMP | dellos9 |
snmp_host.communitystring |
chaîne | Configure la chaîne de communauté SNMP de l'hôte de trap | dellos6, dellos9, dellos10 |
snmp_host.udpport |
chaîne | Configure le numéro UDP de l'hôte de trap SNMP (0 à 65535) | dellos6, dellos9, dellos10 |
snmp_host.version |
chaîne (obligatoire) | Spécifie la version SNMP de l'hôte (1 ou 2c ou 3 dans dellos9, 1 ou 2c dans dellos10) | dellos9, dellos10 |
snmp_host.vrf |
liste | Configure le VRF de trap SNMP pour l'hôte SNMP (liste des noms VRF) | dellos9 |
snmp_host.state |
chaîne: absent, présent* | Supprime l'hôte de trap SNMP si défini sur absent | dellos6, dellos9, dellos10 |
snmp_traps |
liste | Configure les traps SNMP (voir snmp_traps.* ) |
dellos6, dellos9, dellos10 |
snmp_traps.name |
chaîne | Active les traps SNMP | dellos6, dellos9, dellos10 |
snmp_traps.state |
chaîne: absent, présent* | Supprime le trap SNMP s'il est défini sur absent | dellos6, dellos9, dellos10 |
snmp_engine_id |
chaîne | Configure l'engineID SNMPv3 pour l'agent local | dellos9 |
snmp_view |
liste | Configure les informations de vue SNMPv3 (voir snmp_view.* ) |
dellos9, dellos10 |
snmp_view.name |
chaîne | Configure le nom de la vue SNMP (maximum 20 caractères) | dellos9, dellos10 |
snmp_view.oid_subtree |
entier | Configure la vue SNMP pour l'arborescence OID | dellos9, dellos10 |
snmp_view.include |
booléen: vrai, faux | Spécifie si la famille MIB doit être incluse ou exclue de la vue | dellos9, dellos10 |
snmp_user |
liste | Configure les utilisateurs SNMP pour chaque nom de groupe (voir snmp_user.* ) |
dellos9 |
snmp_user.name |
chaîne (obligatoire) | Configure le nom de l'utilisateur SNMP | dellos9 |
snmp_user.group_name |
chaîne (obligatoire) | Configure le nom du groupe SNMP pour l'utilisateur | dellos9 |
snmp_user.version |
chaîne: 1,2c,3 (obligatoire) | Configure une entrée utilisateur avec la version SNMP spécifiée (1, 2c ou 3) | dellos9 |
snmp_user.access_list |
dictionnaire | Configure les détails de la liste d'accès ; requis pour configurer ou annuler si défini | dellos9 |
snmp_user.access_list.access |
chaîne | Configure la liste d'accès associée à l'utilisateur | dellos9 |
snmp_user.access_list.ipv6 |
chaîne | Configure la liste d'accès IPv6 associée à l'utilisateur | dellos9 |
snmp_user.encryption |
booléen: vrai, faux* | Spécifie le chiffrement pour l'utilisateur SNMP s'il est défini sur vrai | dellos9 |
snmp_user.auth_algorithm |
chaîne: md5,sha | Configure l'algorithme d'autorisation pour l'utilisateur SNMP | dellos9 |
snmp_user.auth_pass |
chaîne | Configure le mot de passe d'authentification pour l'utilisateur | dellos9 |
snmp_user.state |
chaîne: absent, présent* | Supprime l'utilisateur SNMP s'il est défini sur absent | dellos9 |
snmp_group |
liste | Configure les groupes SNMP (voir snmp_group.* ) |
dellos9 |
snmp_group.name |
chaîne (obligatoire) | Configure le nom du groupe SNMP | dellos9 |
snmp_group.version |
chaîne (obligatoire) | Configure l'entrée de groupe avec la version SNMP spécifiée (1, 2c ou 3) | dellos9 |
snmp_group.access_list |
dict | Configure les entrées de la liste d'accès pour le groupe ; requis pour configurer ou annuler si défini | dellos9 |
snmp_group.access_list.access |
chaîne | Configure la liste d'accès associée au groupe | dellos9 |
snmp_group.access_list.ipv6 |
chaîne | Configure la liste d'accès IPv6 associée au groupe | dellos9 |
snmp_group.view |
dict | Configure les entrées de vue pour le groupe ; requis pour configurer ou annuler si défini | dellos9 |
snmp_group.view.notify |
chaîne | Configure la vue de notification associée au groupe | dellos9 |
snmp_group.view.read |
chaîne | Configure la vue de lecture associée au groupe | dellos9 |
snmp_group.view.write |
chaîne | Configure la vue d'écriture associée au groupe | dellos9 |
snmp_group.context |
liste | Configure les entrées de liste de contexte (voir snmp_group.context.* ) |
dellos9 |
snmp_group.context.context_name |
chaîne | Configure les entrées de groupe SNMP avec le nom de contexte spécifié | dellos9 |
snmp_group.context.access_list |
dictionnaire | Configure les entrées de liste d'accès pour le groupe avec contexte | dellos9 |
snmp_group.context.access_list.access |
chaîne | Configure la liste d'accès associée au groupe | dellos9 |
snmp_group.context.access_list.ipv6 |
chaîne | Configure la liste d'accès IPv6 associée au groupe | dellos9 |
snmp_group.context.view |
dictionnaire | Configure les entrées de vue pour le groupe avec contexte | dellos9 |
snmp_group.context.view.notify |
chaîne | Configure la vue de notification associée au groupe | dellos9 |
snmp_group.context.view.read |
chaîne | Configure la vue de lecture associée au groupe | dellos9 |
snmp_group.context.view.write |
chaîne | Configure la vue d'écriture associée au groupe | dellos9 |
snmp_group.context.state |
chaîne: absent, présent | Supprime les entrées de contexte avec le groupe si défini sur absent | dellos9 |
snmp_group.state |
chaîne: absent, présent* | Supprime le groupe SNMP associé s'il est défini sur absent | dellos9 |
REMARQUE : Un astérisque (*) indique la valeur par défaut si aucune n'est spécifiée.
Variables de connexion
Les rôles Ansible Dell EMC Networking nécessitent des informations de connexion pour établir la communication avec les nœuds de votre inventaire. Ces informations peuvent exister dans les répertoires group_vars ou host_vars, ou dans le playbook lui-même.
Clé | Obligatoire | Choix | Description |
---|---|---|---|
ansible_host |
oui | Spécifie le nom d'hôte ou l'adresse pour se connecter à l'appareil distant via le transport spécifié | |
ansible_port |
non | Spécifie le port utilisé pour établir la connexion à l'appareil distant ; si la valeur n'est pas spécifiée, l'option ANSIBLE_REMOTE_PORT est utilisée par défaut à 22 | |
ansible_ssh_user |
non | Spécifie le nom d'utilisateur qui authentifie la connexion CLI à l'appareil distant ; si la valeur n'est pas spécifiée, la valeur de la variable d'environnement ANSIBLE_REMOTE_USER est utilisée | |
ansible_ssh_pass |
non | Spécifie le mot de passe qui authentifie la connexion à l'appareil distant | |
ansible_become |
non | oui, non* | Indique au module d'entrer en mode privilégié sur l'appareil distant avant d'envoyer des commandes ; si la valeur n'est pas spécifiée, la valeur de la variable d'environnement ANSIBLE_BECOME est utilisée et l'appareil tente d'exécuter toutes les commandes en mode non privilégié |
ansible_become_method |
non | enable, sudo* | Indique au module de permettre à la méthode de lever de privilège d'être spécifiée ; si la valeur n'est pas spécifiée, la valeur de la variable d'environnement ANSIBLE_BECOME_METHOD est utilisée |
ansible_become_pass |
non | Spécifie le mot de passe à utiliser si nécessaire pour entrer en mode privilégié sur l'appareil distant ; si ansible_become est défini sur non, cette clé n'est pas applicable |
|
ansible_network_os |
oui | dellos6/dellos9/dellos10, null* | Charge les plugins de terminal et cliconf appropriés pour communiquer avec l'appareil distant |
REMARQUE : Un astérisque (*) indique la valeur par défaut si aucune n'est spécifiée.
Dépendances
Le rôle dellos-snmp est construit sur des modules inclus dans le code Ansible de base. Ces modules ont été ajoutés dans la version 2.2.0 d'Ansible.
Exemple de playbook
Cet exemple utilise le rôle dellos.dellos-snmp pour configurer complètement les attributs du serveur SNMP. Il crée un fichier hosts avec les détails du switch et les variables correspondantes. Le fichier hosts doit définir la variable ansible_network_os avec le nom correspondant du système d'exploitation réseau Dell EMC.
Lorsque dellos_cfg_generate est défini sur true, la variable génère les commandes de configuration sous forme de fichier .part dans le chemin build_dir. Par défaut, la variable est définie sur false. Il écrit un simple playbook qui ne fait référence qu'au rôle dellos-snmp. En incluant le rôle, vous avez automatiquement accès à toutes les tâches pour configurer les fonctionnalités SNMP.
Exemple de fichier hosts
leaf1 ansible_host= <ip_address>
Exemple de host_vars/leaf1
hostname: leaf1
ansible_become: oui
ansible_become_method: xxxxx
ansible_become_pass: xxxxx
ansible_ssh_user: xxxxx
ansible_ssh_pass: xxxxx
ansible_network_os: dellos9
build_dir: ../temp/dellos9
dellos_snmp:
snmp_contact: test
snmp_location: chennai
snmp_server_vrf: test
snmp_community:
- name: public
access_mode: ro
state: present
- name: private
access_mode: rw
state: present
snmp_host:
- ipv6: 2001:4898:f0:f09b::2000
version: "3"
security_level: auth
communitystring:
udpport:
state: absent
snmp_traps:
- name: config
state: present
snmp_engine_id: 1234567890
snmp_view:
- name: view_1
oid_subtree: 2
include: false
state: absent
snmp_user:
- name: user_1
group_name: grp1
version: 3
access_list:
access: a1
ipv6: ip1
encryption: true
auth_algorithm: md5
auth_pass: 12345678
state: present
snmp_group:
- name: group_1
version: 2c
access_list:
access: a1
ipv6: ip1
state: absent
- name: group_2
version: 3
security_level: priv
access_list:
access: a1
ipv6: ip1
context:
- context_name: c1
state: present
- context_name: c2
access_list:
access: a1
view:
read: r1
state: present
state: present
Playbook simple pour configurer SNMP - leaf.yaml
- hosts: leaf1
roles:
- Dell-Networking.dellos-snmp
Exécution
ansible-playbook -i hosts leaf.yaml
(c) 2017 Dell Inc. ou ses filiales. Tous droits réservés.
The dellos-snmp role facilitates the configuration of snmp attributes in devices running Dell EMC Networking Operating Systems.
ansible-galaxy install Dell-Networking.dellos-snmp