{"id":21802,"date":"2023-08-14T04:18:01","date_gmt":"2023-08-14T04:18:01","guid":{"rendered":"https:\/\/www.devopsschool.com\/blog\/?p=21802"},"modified":"2023-08-14T04:28:28","modified_gmt":"2023-08-14T04:28:28","slug":"example-code-of-ansible-variable-with-playbook","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/example-code-of-ansible-variable-with-playbook\/","title":{"rendered":"Ansible Tutorials: Ansible Variables in Playbook"},"content":{"rendered":"\n
\"\"<\/figure>\n\n\n\n
    \n
  1. Inventories:<\/strong> You can define variables in your inventory files, either globally for all hosts or specific to particular groups or hosts.<\/li>\n\n\n\n
  2. Host or Group Variables:<\/strong> Create separate files for host or group variables inside the host_vars<\/code> and group_vars<\/code> directories within your Ansible project.<\/li>\n\n\n\n
  3. Playbook-level Variables:<\/strong> Declare variables at the top level of your playbook using the vars<\/code> keyword.<\/li>\n<\/ol>\n\n\n\n

    Ansible Variable in Playbook with following ways:<\/h4>\n\n\n\n
      \n
    • Use variables in playbook directly<\/li>\n\n\n\n
    • Use variables using external var files in playbook<\/li>\n\n\n\n
    • Use variables using include_vars into task in playbook<\/li>\n\n\n\n
    • Use variables using User Prompt in playbook<\/li>\n\n\n\n
    • Use variables using outout of task using register<\/li>\n<\/ul>\n\n\n\n

      List of Way to declare variables in Playbook<\/h2>\n\n\n\n
      \"\"<\/figure>\n\n\n\n
        \n
      1. Playbook-level Variables: <\/strong>Declare variables at the top level of your playbook using the vars keyword.<\/li>\n\n\n\n
      2. Task-level Variables: <\/strong>You can also define variables within specific tasks.<\/li>\n\n\n\n
      3. Register Variables: You can capture the output of a task into a variable using the register keyword.<\/li>\n\n\n\n
      4. Environment Variables:<\/strong> You can use environment variables by accessing them using Ansible’s ansible_env dictionary.<\/li>\n\n\n\n
      5. Using Facts:<\/strong> Ansible gathers facts about managed hosts, and you can use these facts as variables in your playbooks.<\/li>\n\n\n\n
      6. Prompting for User Input:<\/strong> You can use the vars_prompt keyword to prompt the user for input during playbook execution.<\/li>\n<\/ol>\n\n\n\n

        Declare variables at the top level of your playbook using the vars<\/code> keyword.<\/h2>\n\n\n\n
        \n\n\n
        - name: Example playbook\n  hosts: all\n  vars:\n    variable_name: value\n  tasks:\n    # Your tasks here<\/span>\n<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
        Task-level Variables:<\/strong><\/h2>\n\n\n\n
        \n\n\n
        - name: Example playbook\n  hosts<\/span>: all\n  tasks<\/span>:\n    - name: Task with<\/span> variables\n      debug<\/span>:\n        msg: \"My variable: {{ variable_name }}\"<\/span>\n      vars<\/span>:\n        variable_name: value\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
        Register Variables:<\/strong><\/h2>\n\n\n\n
        \n\n\n
        - name: Example playbook\n  hosts<\/span>: all\n  tasks<\/span>:\n    - name: Task with<\/span> register\n      shell<\/span>: echo \"Hello, world!\"<\/span>\n      register<\/span>: output\n    - name: Display registered variable\n      debug<\/span>:\n        var<\/span>: output.stdout\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
        \n\n\n\n
        Environment Variables:<\/strong><\/h2>\n\n\n\n
        \n\n\n
        - name: Example playbook\n  hosts<\/span>: all\n  tasks<\/span>:\n    - name: Display environment variable\n      debug<\/span>:\n        var<\/span>: ansible_env.VARIABLE_NAME\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
        \n\n\n\n
        Using Facts:<\/strong><\/h2>\n\n\n\n
        \n\n\n
        - name: Example playbook\n  hosts<\/span>: all\n  tasks<\/span>:\n    - name: Display fact\n      debug<\/span>:\n        var<\/span>: ansible_facts['ansible_os_family'<\/span>]\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
        \n\n\n\n
        Prompting for User Input:<\/strong><\/h2>\n\n\n\n
        \n\n\n
        - name: Example playbook\n  hosts<\/span>: all\n  vars_prompt<\/span>:\n    - name: variable_name\n      prompt<\/span>: \"Enter a value for the variable:\"<\/span>\n  tasks<\/span>:\n    - name: Display input variable\n      debug<\/span>:\n        var<\/span>: variable_name\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
        \n\n\n\n
        Ansible Playbook with Variable for Centos\/RHEL<\/h2>\n\n\n\n
        \n\n\n
        ---\n- name: Update web servers\n  hosts: web\n  vars:\n    myname: \"Rajeshkumar\"<\/span>\n    age: \"18\"<\/span>\n    packagename: \"httpd\"<\/span>\n    servicename: \"httpd\"<\/span>\n  vars_files:\n    - \"vars.yaml\"<\/span>\n  vars_prompt:\n    - name: \"version\"<\/span>\n      prompt: \"Which version Do you want to install?\"<\/span>\n      private<\/span>: no\n\n  tasks:\n  - name: Install Apache in centos7\n    ansible.builtin.yum:\n      name: \"{{ packagename }}\"<\/span>\n      state: latest\n  - name: Copy index.html\n    ansible.builtin.copy:\n      src: index.html\n      dest: \/var<\/span>\/www\/html\/index.html\n  - name: Starting a Apache Server\n    ansible.builtin.service:\n      name: \"{{ servicename }}\"<\/span>\n      state: started\n  - name: Print<\/span> return<\/span> information from the previous task\n    ansible.builtin.debug:\n      var<\/span>: myname\n  - name: include<\/span> default<\/span> step variables\n    include_vars: tasks_var.yaml\n  - name: Print<\/span> return<\/span> information from the previous task\n    ansible.builtin.debug:\n      msg: \"My Name is {{ myname }} and My age is {{ age }}\"<\/span>\n  - name: Print<\/span> return<\/span> information from the previous task\n    ansible.builtin.debug:\n      var<\/span>: version\n  - name: Ansible register variable basic example\n    shell: \"find *.txt\"<\/span>\n    args:\n      chdir: \"\/home\/azureuser\/rajesh\"<\/span>\n    register: find_output\n  - debug:\n      var<\/span>: find_output\n  - debug:\n      var<\/span>: find_output.stdout_lines\n  - debug:\n      var<\/span>: find_output.stdout_lines[0<\/span>]<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
        \n\n\n\n
        Ansible Playbook with Variable for Ubuntu<\/h2>\n\n\n
        ---\n- name: Update web servers\n  hosts: web\n  vars:\n    myname: \"Rajeshkumar\"<\/span>\n    age: \"18\"<\/span>\n    packagename: \"apache2\"<\/span>\n    servicename: \"apache2\"<\/span>\n  vars_files:\n    - \"vars.yaml\"<\/span>\n  vars_prompt:\n    - name: \"version\"<\/span>\n      prompt: \"Which version Do you want to install?\"<\/span>\n      private<\/span>: no\n\n  tasks:\n  - name: Install Apache in ubuntu\n    ansible.builtin.apt:\n      name: \"{{ packagename }}\"<\/span>\n      state: latest\n  - name: Copy index.html\n    ansible.builtin.copy:\n      src: index.html\n      dest: \/var<\/span>\/www\/html\/index.html\n  - name: Starting a Apache Server\n    ansible.builtin.service:\n      name: \"{{ servicename }}\"<\/span>\n      state: started\n  - name: Print<\/span> return<\/span> information from the previous task\n    ansible.builtin.debug:\n      var<\/span>: myname\n  - name: include<\/span> default<\/span> step variables\n    include_vars: tasks_var.yaml\n  - name: Print<\/span> return<\/span> information from the previous task\n    ansible.builtin.debug:\n      msg: \"My Name is {{ myname }} and My age is {{ age }}\"<\/span>\n  - name: Print<\/span> return<\/span> information from the previous task\n    ansible.builtin.debug:\n      var<\/span>: version\n  - name: Ansible register variable basic example\n    shell: \"find *.txt\"<\/span>\n    args:\n      chdir: \"\/root\/ansible\"<\/span>\n    register: find_output\n  - debug:\n      var<\/span>: find_output\n  - debug:\n      var<\/span>: find_output.stdout_lines\n  - debug:\n      var<\/span>: find_output.stdout_lines[0<\/span>]<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
        <\/p>\n\n\n\n
        Ansible Varialble Precedence<\/h2>\n\n\n\n
        \"\"<\/figure>\n\n\n\n
        \n\n\n