Note

Ce plugin fait partie de la collection vyos.vyos (version 1.1.1).

Pour l'installer, utilisez : ansible-galaxy collection install vyos.vyos.

Pour l'utiliser dans un playbook, spécifiez : vyos.vyos.vyos_ospfv3.

Nouveau dans la version 1.0.0 : de vyos.vyos

  • Synopsis
  • Paramètres
  • Notes
  • Exemples
  • Valeurs de retour

Synopsis

  • Ce module de ressources configure et gère les attributs des routes OSPFv3 sur les périphériques réseau VyOS.

Note

Ce module a un correspondant plugin d'action.

Paramètres

Paramètre Choix/Par défaut Commentaires
configdictionnaire Une configuration de route OSPFv3 fournie.
zonesliste / éléments=dictionnaire Zone OSPFv3.
area_idchaîne de caractères Nom/identité de la zone OSPFv3.
export_listchaîne de caractères Nom de la liste d'exportation.
liste_importchaîne de caractères Nom de la liste d'importation.
gammeliste / elements=dictionnaire Résume les routes correspondant au préfixe (routeurs frontaliers uniquement).
adressechaîne de caractères adresse IPv4 du routeur frontalier.
annoncebooléen
    Choix :

  • pas de
  • oui
Annoncez cette plage.
pas_de_publicitébooléen
    Choix :

  • pas de
  • oui
Ne pas faire de publicité pour cette gamme.
paramètresdictionnaire Paramètres spécifiques à OSPFv3.
router_idchaîne de caractères Remplace l'identifiant de routeur par défaut.
redistribuerliste / elements=dictionnaire Redistribuer les informations d'un autre protocole de routage.
route_mapchaîne de caractères Références de la carte des routes.
route_typechaîne de caractères
    Choix :

  • bgp
  • connecté
  • kernel
  • ripng
  • statique
Type de route à redistribuer.
running_configchaîne de caractères Cette option est utilisée uniquement avec l'état analysé.La valeur de cette option doit être la sortie reçue du dispositif VyOS en exécutant la commande commandes de configuration de spectacle | grep ospfv3.l'état analysé lit la configuration de running_config et la transforme en données structurées Ansible selon l'argspec du module de ressources et la valeur est ensuite retournée dans l'option analysé dans le résultat.
étatchaîne de caractères
    Choix :

  • fusionné
  • a remplacé
  • supprimé
  • analysé
  • rassemblé
  • rendu
L'état dans lequel la configuration doit être laissée.

Notes

Note

  • Testé contre VyOS 1.1.8 (hélium).
  • Ce module fonctionne avec la connexion network_cli. Voir les options de la plate-forme VyOS OS.

Exemples

# Using merged## Before state:# -------------## [email protected]# run show  configuration commands | grep ospfv3##-name: Merge the provided configuration with the exisiting running configuration
  vyos.vyos.vyos_ospfv3:config:redistribute:-route_type: bgp
      parameters:router_id: 192.0.2.10
      areas:-area_id:'2'export_list: export1
        import_list: import1
        range:-address: 2001:db10::/32
        -address: 2001:db20::/32
        -address: 2001:db30::/32
      -area_id:'3'range:-address: 2001:db40::/32
    state: merged
### -------------------------# Module Execution Result# -------------------------## before": {}##    "commands": [#       "set protocols ospfv3 redistribute bgp",#       "set protocols ospfv3 parameters router-id '192.0.2.10'",#       "set protocols ospfv3 area 2 range 2001:db10::/32",#       "set protocols ospfv3 area 2 range 2001:db20::/32",#       "set protocols ospfv3 area 2 range 2001:db30::/32",#       "set protocols ospfv3 area '2'",#       "set protocols ospfv3 area 2 export-list export1",#       "set protocols ospfv3 area 2 import-list import1",#       "set protocols ospfv3 area '3'",#       "set protocols ospfv3 area 3 range 2001:db40::/32"#    ]## "after": {#        "areas": [#            {#                "area_id": "2",#                "export_list": "export1",#                "import_list": "import1",#                "range": [#                    {#                        "address": "2001:db10::/32"#                    },#                    {#                        "address": "2001:db20::/32"#                    },#                    {#                        "address": "2001:db30::/32"#                    }#                ]#            },#            {#                "area_id": "3",#                "range": [#                    {#                        "address": "2001:db40::/32"#                    }#                ]#            }#        ],#        "parameters": {#            "router_id": "192.0.2.10"#        },#        "redistribute": [#            {#                "route_type": "bgp"#            }#        ]#    }## After state:# -------------## [email protected]# run show configuration commands | grep ospfv3# set protocols ospfv3 area 2 export-list 'export1'# set protocols ospfv3 area 2 import-list 'import1'# set protocols ospfv3 area 2 range '2001:db10::/32'# set protocols ospfv3 area 2 range '2001:db20::/32'# set protocols ospfv3 area 2 range '2001:db30::/32'# set protocols ospfv3 area 3 range '2001:db40::/32'# set protocols ospfv3 parameters router-id '192.0.2.10'# set protocols ospfv3 redistribute 'bgp'# Using replaced## Before state:# -------------## [email protected]# run show configuration commands | grep ospfv3# set protocols ospfv3 area 2 export-list 'export1'# set protocols ospfv3 area 2 import-list 'import1'# set protocols ospfv3 area 2 range '2001:db10::/32'# set protocols ospfv3 area 2 range '2001:db20::/32'# set protocols ospfv3 area 2 range '2001:db30::/32'# set protocols ospfv3 area 3 range '2001:db40::/32'# set protocols ospfv3 parameters router-id '192.0.2.10'# set protocols ospfv3 redistribute 'bgp'#-name: Replace ospfv3 routes attributes configuration.
  vyos.vyos.vyos_ospfv3:config:redistribute:-route_type: bgp
      parameters:router_id: 192.0.2.10
      areas:-area_id:'2'export_list: export1
        import_list: import1
        range:-address: 2001:db10::/32
        -address: 2001:db30::/32
        -address: 2001:db50::/32
      -area_id:'4'range:-address: 2001:db60::/32
    state: replaced
### -------------------------# Module Execution Result# -------------------------##    "before": {#        "areas": [#            {#                "area_id": "2",#                "export_list": "export1",#                "import_list": "import1",#                "range": [#                    {#                        "address": "2001:db10::/32"#                    },#                    {#                        "address": "2001:db20::/32"#                    },#                    {#                        "address": "2001:db30::/32"#                    }#                ]#            },#            {#                "area_id": "3",#                "range": [#                    {#                        "address": "2001:db40::/32"#                    }#                ]#            }#        ],#        "parameters": {#            "router_id": "192.0.2.10"#        },#        "redistribute": [#            {#                "route_type": "bgp"#            }#        ]#    }## "commands": [#     "delete protocols ospfv3 area 2 range 2001:db20::/32",#     "delete protocols ospfv3 area 3",#     "set protocols ospfv3 area 2 range 2001:db50::/32",#     "set protocols ospfv3 area '4'",#     "set protocols ospfv3 area 4 range 2001:db60::/32"#    ]##    "after": {#        "areas": [#            {#                "area_id": "2",#                "export_list": "export1",#                "import_list": "import1",#                "range": [#                    {#                        "address": "2001:db10::/32"#                    },#                    {#                        "address": "2001:db30::/32"#                    },#                    {#                        "address": "2001:db50::/32"#                    }#                ]#            },#            {#                "area_id": "4",#                "range": [#                    {#                        "address": "2001:db60::/32"#                    }#                ]#            }#        ],#        "parameters": {#            "router_id": "192.0.2.10"#        },#        "redistribute": [#            {#                "route_type": "bgp"#            }#        ]#    }## After state:# -------------## [email protected]# run show configuration commands | grep ospfv3# set protocols ospfv3 area 2 export-list 'export1'# set protocols ospfv3 area 2 import-list 'import1'# set protocols ospfv3 area 2 range '2001:db10::/32'# set protocols ospfv3 area 2 range '2001:db30::/32'# set protocols ospfv3 area 2 range '2001:db50::/32'# set protocols ospfv3 area 4 range '2001:db60::/32'# set protocols ospfv3 parameters router-id '192.0.2.10'# set protocols ospfv3 redistribute 'bgp'# Using rendered##-name: Render the commands for provided  configuration
  vyos.vyos.vyos_ospfv3:config:redistribute:-route_type: bgp
      parameters:router_id: 192.0.2.10
      areas:-area_id:'2'export_list: export1
        import_list: import1
        range:-address: 2001:db10::/32
        -address: 2001:db20::/32
        -address: 2001:db30::/32
      -area_id:'3'range:-address: 2001:db40::/32
    state: rendered
### -------------------------# Module Execution Result# -------------------------### "rendered": [#        [#       "set protocols ospfv3 redistribute bgp",#       "set protocols ospfv3 parameters router-id '192.0.2.10'",#       "set protocols ospfv3 area 2 range 2001:db10::/32",#       "set protocols ospfv3 area 2 range 2001:db20::/32",#       "set protocols ospfv3 area 2 range 2001:db30::/32",#       "set protocols ospfv3 area '2'",#       "set protocols ospfv3 area 2 export-list export1",#       "set protocols ospfv3 area 2 import-list import1",#       "set protocols ospfv3 area '3'",#       "set protocols ospfv3 area 3 range 2001:db40::/32"#    ]# Using parsed##-name: Parse the commands to provide structured configuration.
  vyos.vyos.vyos_ospfv3:running_config:
      "set protocols ospfv3 area 2 export-list 'export1'
       set protocols ospfv3 area 2 import-list 'import1'
       set protocols ospfv3 area 2 range '2001:db10::/32'
       set protocols ospfv3 area 2 range '2001:db20::/32'
       set protocols ospfv3 area 2 range '2001:db30::/32'
       set protocols ospfv3 area 3 range '2001:db40::/32'
       set protocols ospfv3 parameters router-id '192.0.2.10'
       set protocols ospfv3 redistribute 'bgp'"
    state: parsed
### -------------------------# Module Execution Result# -------------------------### "parsed": {#        "areas": [#            {#                "area_id": "2",#                "export_list": "export1",#                "import_list": "import1",#                "range": [#                    {#                        "address": "2001:db10::/32"#                    },#                    {#                        "address": "2001:db20::/32"#                    },#                    {#                        "address": "2001:db30::/32"#                    }#                ]#            },#            {#                "area_id": "3",#                "range": [#                    {#                        "address": "2001:db40::/32"#                    }#                ]#            }#        ],#        "parameters": {#            "router_id": "192.0.2.10"#        },#        "redistribute": [#            {#                "route_type": "bgp"#            }#        ]#    }# Using gathered## Before state:# -------------## [email protected]# run show configuration commands | grep ospfv3# set protocols ospfv3 area 2 export-list 'export1'# set protocols ospfv3 area 2 import-list 'import1'# set protocols ospfv3 area 2 range '2001:db10::/32'# set protocols ospfv3 area 2 range '2001:db20::/32'# set protocols ospfv3 area 2 range '2001:db30::/32'# set protocols ospfv3 area 3 range '2001:db40::/32'# set protocols ospfv3 parameters router-id '192.0.2.10'# set protocols ospfv3 redistribute 'bgp'#-name: Gather ospfv3 routes config with provided configurations
  vyos.vyos.vyos_ospfv3:config:state: gathered
### -------------------------# Module Execution Result# -------------------------##    "gathered": {#        "areas": [#            {#                "area_id": "2",#                "export_list": "export1",#                "import_list": "import1",#                "range": [#                    {#                        "address": "2001:db10::/32"#                    },#                    {#                        "address": "2001:db20::/32"#                    },#                    {#                        "address": "2001:db30::/32"#                    }#                ]#            },#            {#                "area_id": "3",#                "range": [#                    {#                        "address": "2001:db40::/32"#                    }#                ]#            }#        ],#        "parameters": {#            "router_id": "192.0.2.10"#        },#        "redistribute": [#            {#                "route_type": "bgp"#            }#        ]#    }## After state:# -------------## [email protected]# run show configuration commands | grep ospfv3# set protocols ospfv3 area 2 export-list 'export1'# set protocols ospfv3 area 2 import-list 'import1'# set protocols ospfv3 area 2 range '2001:db10::/32'# set protocols ospfv3 area 2 range '2001:db20::/32'# set protocols ospfv3 area 2 range '2001:db30::/32'# set protocols ospfv3 area 3 range '2001:db40::/32'# set protocols ospfv3 parameters router-id '192.0.2.10'# set protocols ospfv3 redistribute 'bgp'# Using deleted## Before state# -------------## [email protected]# run show configuration commands | grep ospfv3# set protocols ospfv3 area 2 export-list 'export1'# set protocols ospfv3 area 2 import-list 'import1'# set protocols ospfv3 area 2 range '2001:db10::/32'# set protocols ospfv3 area 2 range '2001:db20::/32'# set protocols ospfv3 area 2 range '2001:db30::/32'# set protocols ospfv3 area 3 range '2001:db40::/32'# set protocols ospfv3 parameters router-id '192.0.2.10'# set protocols ospfv3 redistribute 'bgp'#-name: Delete attributes of ospfv3 routes.
  vyos.vyos.vyos_ospfv3:config:state: deleted
### ------------------------# Module Execution Results# ------------------------##    "before": {#        "areas": [#            {#                "area_id": "2",#                "export_list": "export1",#                "import_list": "import1",#                "range": [#                    {#                        "address": "2001:db10::/32"#                    },#                    {#                        "address": "2001:db20::/32"#                    },#                    {#                        "address": "2001:db30::/32"#                    }#                ]#            },#            {#                "area_id": "3",#                "range": [#                    {#                        "address": "2001:db40::/32"#                    }#                ]#            }#        ],#        "parameters": {#            "router_id": "192.0.2.10"#        },#        "redistribute": [#            {#                "route_type": "bgp"#            }#        ]#    }# "commands": [#        "delete protocols ospfv3"#    ]## "after": {}# After state# ------------# [email protected]# run show configuration commands | grep ospfv3

Valeurs de retour

Les valeurs de retour courantes sont documentées ici, les champs suivants sont uniques à ce module :

Clé Retourné Description
aprèsdictionnaire lorsque modifié L'invocation du modèle de configuration qui en résulte.
Echantillon : La configuration retournée sera toujours dans le même format des paramètres ci-dessus.
avantdictionnaire toujours La configuration préalable à l'invocation du modèle.
Exemple : La configuration retournée sera toujours dans le même format des paramètres ci-dessus.
Commandesliste / elements=chaîne toujours L'ensemble des commandes poussées vers le périphérique distant.
Exemple :['set protocols ospf parameters router-id 192.0.1.1', "set protocols ospfv3 area 2 range '2001:db10::/32'"]

Auteurs

  • Rohit Thakur (@rohitthakur2590)