csit/libraries/OpenStackOperations.robot

   1 *** Settings ***
   2 Documentation     Openstack library. This library is useful for tests to create network, subnet, router and vm instances
   3 Library           Collections
   4 Library           Process
   5 Library           OperatingSystem
   6 Library           RequestsLibrary
   7 Library           SSHLibrary
   8 Library           String
   9 Resource          DataModels.robot
  10 Resource          DevstackUtils.robot
  11 Resource          KarafKeywords.robot
  12 Resource          L2GatewayOperations.robot
  13 Resource          ODLTools.robot
  14 Resource          OVSDB.robot
  15 Resource          SetupUtils.robot
  16 Resource          SSHKeywords.robot
  17 Resource          Tcpdump.robot
  18 Resource          Utils.robot
  19 Resource          ../variables/Variables.robot
  20 Resource          ../variables/netvirt/Variables.robot
  21 Variables         ../variables/netvirt/Modules.py
  22
  23 *** Variables ***
  24 @{VALIDATION_KEYWORDS}    Verify Services    Verify Expected Default Tunnels    Verify Expected Default Tables On Nodes
  25 ${VALIDATION_FILE}    /tmp/validations.txt
  26
  27 *** Keywords ***
  28 Get Tenant ID From Security Group
  29     [Documentation]    Returns tenant ID by reading it from existing default security-group.
  30     ${output} =    OpenStack CLI    openstack security group show default | grep "| tenant_id" | awk '{print $4}'
  31     [Return]    ${output}
  32
  33 Get Tenant ID From Network
  34     [Arguments]    ${network_uuid}
  35     [Documentation]    Returns tenant ID by reading it from existing network.
  36     ${resp} =    TemplatedRequests.Get_From_Uri    uri=${CONFIG_API}/neutron:neutron/networks/network/${network_uuid}/    accept=${ACCEPT_EMPTY}    session=session
  37     ${tenant_id} =    Utils.Extract Value From Content    ${resp}    /network/0/tenant-id    strip
  38     [Return]    ${tenant_id}
  39
  40 Create Network
  41     [Arguments]    ${network_name}    ${additional_args}=${EMPTY}    ${verbose}=TRUE
  42     [Documentation]    Create Network with openstack request.
  43     ${output} =    OpenStack CLI    openstack network create ${network_name} ${additional_args}
  44     [Return]    ${output}
  45
  46 Create Multiple Networks
  47     [Arguments]    @{name_of_networks}
  48     [Documentation]    Create required number of networks and return a list of the resulting network ids
  49     ${net_list_ids} =    BuiltIn.Create List    @{EMPTY}
  50     FOR    ${net}    IN    @{name_of_networks}
  51         ${output} =    OpenStackOperations.Create Network    ${net}
  52         ${net_id} =    Get Regexp Matches    ${output}    ${REGEX_UUID}
  53         Collections.Append To List    ${net_list_ids}    ${net_id}
  54     END
  55     [Return]    @{net_list_ids}
  56
  57 Update Network
  58     [Arguments]    ${network_name}    ${additional_args}=${EMPTY}
  59     [Documentation]    Update Network with neutron request.
  60     ${output} =    OpenStack CLI    openstack network set ${network_name} ${additional_args}
  61     [Return]    ${output}
  62
  63 Show Network
  64     [Arguments]    ${network_name}
  65     [Documentation]    Show Network with neutron request.
  66     ${output} =    OpenStack CLI    openstack network show ${network_name}
  67     [Return]    ${output}
  68
  69 List Networks
  70     [Documentation]    List networks and return output with neutron client.
  71     ${output} =    OpenStack CLI    openstack network list
  72     [Return]    ${output}
  73
  74 List Subnets
  75     [Documentation]    List subnets and return output with neutron client.
  76     ${output} =    OpenStack CLI    openstack subnet list
  77     [Return]    ${output}
  78
  79 Delete Network
  80     [Arguments]    ${network_name}
  81     [Documentation]    Delete Network with neutron request.
  82     ${output} =    OpenStack CLI    openstack network delete ${network_name}
  83
  84 Create SubNet
  85     [Arguments]    ${network_name}    ${subnet_name}    ${range_ip}    ${additional_args}=${EMPTY}
  86     [Documentation]    Create SubNet for the Network with neutron request.
  87     ${output} =    OpenStack CLI    openstack subnet create --network ${network_name} --subnet-range ${range_ip} ${subnet_name} ${additional_args}
  88
  89 Create Multiple Subnets
  90     [Arguments]    ${network_names}    ${subnet_names}    ${subnet_cidr}
  91     [Documentation]    Create required number of subnets for previously created networks and return subnet id
  92     ${number_of_networks} =    BuiltIn.Get Length    ${network_names}
  93     @{subnet_id_list} =    BuiltIn.Create List    @{EMPTY}
  94     FOR    ${index}    IN RANGE    ${number_of_networks}
  95         OpenStackOperations.Create SubNet    ${network_names[${index}]}    ${subnet_names[${index}]}    ${subnet_cidr[${index}]}
  96     END
  97     ${sub_list} =    OpenStackOperations.List Subnets
  98     FOR    ${index}    IN RANGE    ${number_of_networks}
  99         BuiltIn.Should Contain    ${sub_list}    ${subnet_names[${index}]}
 100         ${subnet_id} =    OpenStackOperations.Get Subnet Id    ${subnet_names[${index}]}
 101         Collections.Append To List    ${subnet_id_list}    ${subnet_id}
 102     END
 103     [Return]    @{subnet_id_list}
 104
 105 Update SubNet
 106     [Arguments]    ${subnet_name}    ${additional_args}=${EMPTY}
 107     [Documentation]    Update subnet with openstack subnet set request.
 108     ${output} =    OpenStack CLI    openstack subnet set ${subnet_name} ${additional_args}
 109     [Return]    ${output}
 110
 111 Unset SubNet
 112     [Arguments]    ${subnet_name}    ${additional_args}=${EMPTY}
 113     [Documentation]    Update subnet with openstack subnet unset request
 114     ${output} =    OpenStack CLI    openstack subnet unset ${subnet_name} ${additional_args}
 115     [Return]    ${output}
 116
 117 Show SubNet
 118     [Arguments]    ${subnet_name}
 119     [Documentation]    Show subnet with neutron request.
 120     ${output} =    OpenStack CLI    openstack subnet show ${subnet_name}
 121     [Return]    ${output}
 122
 123 Create Port
 124     [Arguments]    ${network_name}    ${port_name}    ${sg}=default    ${additional_args}=${EMPTY}    ${allowed_address_pairs}=${EMPTY}
 125     [Documentation]    Create Port with neutron request.
 126     # if allowed_address_pairs is not empty we need to create the arguments to pass to the port create command. They are
 127     # in a different format with the neutron vs openstack cli.
 128     ${address_pair_length} =    BuiltIn.Get Length    ${allowed_address_pairs}
 129     ${allowed_pairs_argv} =    BuiltIn.Set Variable    ${EMPTY}
 130     ${allowed_pairs_argv} =    BuiltIn.Set Variable If    '${address_pair_length}'=='2'    --allowed-address ip-address=@{allowed_address_pairs}[0] --allowed-address ip-address=@{allowed_address_pairs}[1]    ${allowed_pairs_argv}
 131     ${output} =    OpenStack CLI    openstack port create --network ${network_name} ${port_name} --security-group ${sg} ${additional_args} ${allowed_pairs_argv}
 132
 133 Update Port
 134     [Arguments]    ${port_name}    ${additional_args}=${EMPTY}
 135     [Documentation]    Update port with neutron request.
 136     ${output} =    OpenStack CLI    openstack port set ${port_name} ${additional_args}
 137     [Return]    ${output}
 138
 139 Show Port
 140     [Arguments]    ${port_name}
 141     [Documentation]    Show port with neutron request.
 142     ${output} =    OpenStack CLI    openstack port show ${port_name}
 143     [Return]    ${output}
 144
 145 Delete Port
 146     [Arguments]    ${port_name}
 147     [Documentation]    Delete Port with neutron request.
 148     ${output} =    OpenStack CLI    openstack port delete ${port_name}
 149
 150 List Ports
 151     [Documentation]    List ports and return output with neutron client.
 152     ${output} =    OpenStack CLI    openstack port list
 153     [Return]    ${output}
 154
 155 List Nova VMs
 156     [Documentation]    List VMs and return output with nova client.
 157     ${output} =    OpenStack CLI    openstack server list --all-projects
 158     [Return]    ${output}
 159
 160 Create And Associate Floating IPs
 161     [Arguments]    ${external_net}    @{vm_list}
 162     [Documentation]    Create and associate floating IPs to VMs with nova request
 163     ${ip_list} =    BuiltIn.Create List    @{EMPTY}
 164     FOR    ${vm}    IN    @{vm_list}
 165         ${output} =    OpenStack CLI    openstack floating ip create ${external_net}
 166         @{ip} =    String.Get Regexp Matches    ${output}    [0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}
 167         ${ip_length} =    BuiltIn.Get Length    ${ip}
 168         BuiltIn.Run Keyword If    ${ip_length}>0    Collections.Append To List    ${ip_list}    @{ip}[0]
 169         ...    ELSE    Collections.Append To List    ${ip_list}    None
 170         ${vm_ip} =    OpenStack CLI    openstack server show ${vm} | grep "addresses" | awk '{print $4}' | cut -d"=" -f 2
 171         ${port_id} =    OpenStack CLI    openstack port list | grep "ip_address='${vm_ip}'" | awk '{print $2}' | cut -d"=" -f 2
 172         ${output} =    BuiltIn.Run Keyword If    '${OPENSTACK_BRANCH}' == 'stable/rocky'    OpenStack CLI    openstack floating ip set --port ${port_id} @{ip}[0]
 173         ...    ELSE    OpenStack CLI    openstack server add floating ip ${vm} @{ip}[0]
 174     END
 175     [Return]    ${ip_list}
 176
 177 Remove Floating Ip From Vm
 178     [Arguments]    ${vm_name}    ${fip}
 179     [Documentation]    Remove the Floating IP From VM Instance
 180     ${vm_ip} =    OpenStack CLI    openstack server show ${vm_name} | grep "addresses" | awk '{print $4}' | cut -d"=" -f 2
 181     ${port_id} =    OpenStack CLI    openstack port list | grep "ip_address='${vm_ip}'" | awk '{print $2}' | cut -d"=" -f 2
 182     ${output} =    BuiltIn.Run Keyword If    '${OPENSTACK_BRANCH}' == 'stable/rocky'    OpenStack CLI    openstack floating ip unset --port ${port_id} ${fip}
 183     ...    ELSE    OpenStack CLI    openstack server remove floating ip ${vm_name} ${fip}
 184
 185 Delete Floating IP
 186     [Arguments]    ${fip}
 187     [Documentation]    Delete floating ip with neutron request.
 188     ${output} =    OpenStack CLI    openstack floating ip delete ${fip}
 189
 190 Delete SubNet
 191     [Arguments]    ${subnet}
 192     [Documentation]    Delete SubNet for the Network with neutron request.
 193     ${output} =    OpenStack CLI    openstack subnet delete ${subnet}
 194
 195 Delete Vm Instance
 196     [Arguments]    ${vm_name}
 197     [Documentation]    Delete Vm instances using instance names.
 198     ${output} =    OpenStack CLI    openstack server delete ${vm_name}
 199
 200 Get Net Id
 201     [Arguments]    ${network_name}
 202     [Documentation]    Retrieve the net id for the given network name to create specific vm instance
 203     ${output} =    OpenStack CLI    openstack network list | grep "${network_name}" | awk '{print $2}'
 204     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 205     ${net_id} =    Collections.Get from List    ${splitted_output}    0
 206     [Return]    ${net_id}
 207
 208 Get Subnet Id
 209     [Arguments]    ${subnet_name}
 210     [Documentation]    Retrieve the subnet id for the given subnet name
 211     ${output} =    OpenStack CLI    openstack subnet show "${subnet_name}" | grep " id " | awk '{print $4}'
 212     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 213     ${subnet_id} =    Collections.Get from List    ${splitted_output}    0
 214     [Return]    ${subnet_id}
 215
 216 Get Port Id
 217     [Arguments]    ${port_name}
 218     [Documentation]    Retrieve the port id for the given port name to attach specific vm instance to a particular port
 219     ${output} =    OpenStack CLI    openstack port list | grep "${port_name}" | awk '{print $2}'
 220     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 221     ${port_id} =    Collections.Get from List    ${splitted_output}    0
 222     [Return]    ${port_id}
 223
 224 Get Sub Port Id
 225     [Arguments]    ${portname}
 226     [Documentation]    Retrieve the first 10 chars of the UUID for the given port name
 227     ${port_id} =    OpenStackOperations.Get Port Id    ${portname}
 228     ${output} =    String.Get Regexp Matches    ${port_id}    \\w{8}-\\w{2}
 229     ${subport_id} =    Collections.Get from List    ${output}    0
 230     [Return]    ${subport_id}
 231
 232 Get Router Id
 233     [Arguments]    ${router1}
 234     [Documentation]    Retrieve the router id for the given router name
 235     ${output} =    OpenStack CLI    openstack router show "${router1}" |awk '/ id / {print $4}'
 236     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 237     ${router_id} =    Collections.Get from List    ${splitted_output}    0
 238     [Return]    ${router_id}
 239
 240 Get VMs OVS Port Number
 241     [Arguments]    ${ip_address}    ${portname}
 242     [Documentation]    Get the port number for given portname
 243     ${subportid} =    OpenStackOperations.Get Sub Port Id    ${portname}
 244     ${vm_port_number} =    OVSDB.Get Port Number    ${subportid}    ${ip_address}
 245     [Return]    ${vm_port_number}
 246
 247 Add New Image From Url
 248     [Arguments]    ${image_url}    ${image_name}
 249     [Documentation]    To add new qcow2 images for testing.
 250     ${rc}    ${output} =    OperatingSystem.Run And Return Rc And Output    wget ${image_url} -O /tmp/new_image.qcow2
 251     BuiltIn.Log    ${output}
 252     BuiltIn.Should Be True    '${rc}' == '0'
 253     ${output} =    OpenStack CLI    openstack image create ${image_name} --file /tmp/new_image.qcow2 --disk-format qcow2 --container-format bare --public
 254
 255 Create Flavor
 256     [Arguments]    ${flavor_name}    ${ram_in_mb}    ${disk_in_gb}    ${ncpu}=1
 257     [Documentation]    To create new flavors for instance deployment and testing
 258     ${output} =    OpenStack CLI    openstack flavor create ${flavor_name} --ram ${ram_in_mb} --disk ${disk_in_gb} --vcpus ${ncpu}
 259
 260 Create Keypair
 261     [Arguments]    ${keyname}    ${public_key_file}
 262     [Documentation]    To add keypairs to Openstack that can be used when ssh to instances using publickey authentication
 263     ${output} =    OpenStack CLI    openstack keypair create ${keyname} --public-key ${public_key_file}
 264
 265 Generate And Add Keypair
 266     [Arguments]    ${keyname}    ${keyfilename}
 267     [Documentation]    To generate keypair using ssh-keygen and add them to Openstack
 268     ${result} =    Process.Run Process    ssh-keygen -b 2048 -t rsa -f ${JENKINS_WORKSPACE}/${keyfilename} -q -N ""    shell=True
 269     BuiltIn.Log    ${result.stdout}
 270     BuiltIn.Log    ${result.stderr}
 271     BuiltIn.Should Be True    '${result.rc}' == '0'
 272     OpenStackOperations.Create Keypair    ${keyname}    ${JENKINS_WORKSPACE}/${keyfilename}.pub
 273     OpenStackOperations.Get ControlNode Connection
 274     SSHLibrary.Put_File    ${JENKINS_WORKSPACE}/${keyfilename}    /tmp
 275
 276 Create Vm Instances
 277     [Arguments]    ${net_name}    ${vm_instance_names}    ${image}=${EMPTY}    ${flavor}=m1.nano    ${sg}=default    ${min}=1
 278     [Documentation]    Create X Vm Instance with the net id of the Netowrk.
 279     ..    ${max}=1
 280     ${image}    BuiltIn.Set Variable If    "${image}"=="${EMPTY}"    ${CIRROS_${OPENSTACK_BRANCH}}    ${image}
 281     ${net_id} =    OpenStackOperations.Get Net Id    ${net_name}
 282     FOR    ${vm}    IN    @{vm_instance_names}
 283         ${output} =    OpenStack CLI    openstack server create --image ${image} --flavor ${flavor} --nic net-id=${net_id} ${vm} --security-group ${sg} --min ${min} --max ${max}
 284     END
 285
 286 Create Vm Instance On Compute Node
 287     [Arguments]    ${net_name}    ${vm_name}    ${node_hostname}    ${image}=${EMPTY}    ${flavor}=m1.nano    ${sg}=default
 288     [Documentation]    Create a VM instance on a specific compute node.
 289     ${image} =    BuiltIn.Set Variable If    "${image}"=="${EMPTY}"    ${CIRROS_${OPENSTACK_BRANCH}}    ${image}
 290     ${net_id} =    OpenStackOperations.Get Net Id    ${net_name}
 291     ${output} =    OpenStack CLI    openstack server create ${vm_name} --image ${image} --flavor ${flavor} --nic net-id=${net_id} --security-group ${sg} --availability-zone nova:${node_hostname}
 292
 293 Create Vm Instance With Port
 294     [Arguments]    ${port_name}    ${vm_instance_name}    ${image}=${EMPTY}    ${flavor}=m1.nano    ${sg}=default
 295     [Documentation]    Create One VM instance using given ${port_name} and for given ${compute_node}
 296     ${image} =    BuiltIn.Set Variable If    "${image}"=="${EMPTY}"    ${CIRROS_${OPENSTACK_BRANCH}}    ${image}
 297     ${output} =    OpenStack CLI    openstack server create --image ${image} --flavor ${flavor} --port ${port_name} --security-group ${sg} ${vm_instance_name}
 298
 299 Create Vm Instance With Ports And Key On Compute Node
 300     [Arguments]    ${port1_name}    ${port2_name}    ${vm_instance_name}    ${node_hostname}    ${image}=${EMPTY}    ${flavor}=m1.nano
 301     ...    ${sg}=default    ${keyname}=${EMPTY}
 302     [Documentation]    Create One VM instance using given ${port1_name} and ${port2_name} with keyname for ssh and also on a specific compute node
 303     ${image}    BuiltIn.Set Variable If    "${image}"=="${EMPTY}"    ${CIRROS_${OPENSTACK_BRANCH}}    ${image}
 304     ${output} =    OpenStack CLI    openstack server create --image ${image} --flavor ${flavor} --port ${port1_name} --port ${port2_name} ${vm_instance_name} --security-group ${sg} --availability-zone nova:${node_hostname} --key-name ${keyname}
 305
 306 Create Vm Instance With Port On Compute Node
 307     [Arguments]    ${port_name}    ${vm_instance_name}    ${node_hostname}    ${image}=${EMPTY}    ${flavor}=m1.nano    ${sg}=default
 308     [Documentation]    Create One VM instance using given ${port_name} and for given ${node_hostname}
 309     ${image} =    BuiltIn.Set Variable If    "${image}"=="${EMPTY}"    ${CIRROS_${OPENSTACK_BRANCH}}    ${image}
 310     ${output} =    OpenStack CLI    openstack server create --image ${image} --flavor ${flavor} --port ${port_name} --security-group ${sg} --availability-zone nova:${node_hostname} ${vm_instance_name}
 311
 312 Remove Security Group From Vm Instance
 313     [Arguments]    ${vm_instance_name}    ${security_group}
 314     [Documentation]    Delete the Security Group from the VM Instance.
 315     ${output} =    OpenStack CLI    openstack server remove security group ${vm_instance_name} ${security_group}
 316
 317 Create Vm Instance With Ports On Compute Node
 318     [Arguments]    ${port1_name}    ${port2_name}    ${vm_instance_name}    ${node_hostname}    ${image}=${EMPTY}    ${flavor}=m1.nano
 319     ...    ${sg}=default
 320     [Documentation]    Create One VM instance using given ${port1_name}, ${port2_name} and for given ${node_hostname} with no keys (cirros like)
 321     ${image} =    BuiltIn.Set Variable If    "${image}"=="${EMPTY}"    ${CIRROS_${OPENSTACK_BRANCH}}    ${image}
 322     ${port1_id} =    OpenStackOperations.Get Port Id    ${port1_name}
 323     ${port2_id} =    OpenStackOperations.Get Port Id    ${port2_name}
 324     ${output} =    OpenStack CLI    openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port1_id} --nic port-id=${port2_id} --security-group ${sg} --availability-zone nova:${node_hostname} ${vm_instance_name}
 325
 326 Get Hypervisor Hostname From IP
 327     [Arguments]    ${hypervisor_ip}
 328     [Documentation]    Returns the hostname found for the given IP address if it's listed in hypervisor list. For debuggability
 329     ...    the full listing is logged first, then followed by a grep | cut to focus on the actual hostname to return
 330     ${output} =    OpenStack CLI    openstack hypervisor list
 331     ${hostname} =    OpenStack CLI    openstack hypervisor list -f value | grep "${hypervisor_ip} " | cut -d" " -f 2
 332     [Return]    ${hostname}
 333
 334 Create Nano Flavor
 335     [Documentation]    Create a nano flavor
 336     ${output} =    OpenStack CLI    openstack flavor create m1.nano --id auto --ram 64 --disk 0 --vcpus 1
 337
 338 Verify VM Is ACTIVE
 339     [Arguments]    ${vm_name}
 340     [Documentation]    Run these commands to check whether the created vm instance is active or not.
 341     ${output} =    OpenStack CLI    openstack server show ${vm_name} | grep OS-EXT-STS:vm_state
 342     BuiltIn.Should Contain    ${output}    active
 343
 344 Poll VM Is ACTIVE
 345     [Arguments]    ${vm_name}    ${retry}=600s    ${retry_interval}=30s
 346     [Documentation]    Run these commands to check whether the created vm instance is active or not.
 347     BuiltIn.Wait Until Keyword Succeeds    ${retry}    ${retry_interval}    OpenStackOperations.Verify VM Is ACTIVE    ${vm_name}
 348
 349 Get Match
 350     [Arguments]    ${text}    ${regexp}    ${index}=0
 351     [Documentation]    Wrapper around String.Get Regexp Matches to return None if not found or the first match if found.
 352     @{matches} =    String.Get Regexp Matches    ${text}    ${regexp}
 353     ${matches_length} =    BuiltIn.Get Length    ${matches}
 354     BuiltIn.Set Suite Variable    ${OS_MATCH}    None
 355     BuiltIn.Run Keyword If    ${matches_length} > ${index}    BuiltIn.Set Suite Variable    ${OS_MATCH}    @{matches}[${index}]
 356     [Return]    ${OS_MATCH}
 357
 358 Get VM IP
 359     [Arguments]    ${fail_on_none}    ${vm}
 360     [Documentation]    Get the vm ip address and nameserver by scraping the vm's console log.
 361     ...    Get VM IP returns three values: [0] the vm IP, [1] the DHCP IP and [2] the vm console log.
 362     ${vm_console_output} =    OpenStack CLI With No Log    openstack console log show ${vm}
 363     ${vm_ip} =    BuiltIn.Set Variable    None
 364     ${dhcp_ip} =    BuiltIn.Set Variable    None
 365     ${match} =    OpenStackOperations.Get Match    ${vm_console_output}    ${REGEX_OBTAINED}
 366     ${vm_ip} =    OpenStackOperations.Get Match    ${match}    ${REGEX_IPV4}    0
 367     ${match} =    OpenStackOperations.Get Match    ${vm_console_output}    ${REGEX_IPROUTE}
 368     ${dhcp_ip} =    OpenStackOperations.Get Match    ${match}    ${REGEX_IPV4}    1
 369     BuiltIn.Run Keyword If    '${fail_on_none}' == 'true'    BuiltIn.Should Not Contain    ${vm_ip}    None
 370     BuiltIn.Run Keyword If    '${fail_on_none}' == 'true'    BuiltIn.Should Not Contain    ${dhcp_ip}    None
 371     [Return]    ${vm_ip}    ${dhcp_ip}    ${vm_console_output}
 372
 373 Verify If Instance Is Arpingable From DHCP Namespace
 374     [Arguments]    ${net_name}    ${mac}    ${ip}
 375     [Documentation]    Get the Port IP and check the arp -a from DHCP NS to ensure that the VM's have been assigned IP's
 376     OpenStackOperations.Get ControlNode Connection
 377     ${net_id} =    OpenStackOperations.Get Net Id    ${net_name}
 378     ${output} =    Utils.Write Commands Until Expected Prompt    sudo ip netns exec qdhcp-${net_id} arping ${ip} -c3    ${DEFAULT_LINUX_PROMPT_STRICT}    timeout=60s
 379     ${mac_uppercase} =    String.Convert To Upper Case    ${mac}
 380     BuiltIn.Should Contain    ${output}    [${mac_uppercase}]
 381
 382 Check If Instance Is Ready For Ssh Login Using PublicKey
 383     [Arguments]    ${net_name}    ${vm_ip}    ${user}=centos    ${idfile}=/tmp/odlkey    ${console}=cirros
 384     [Documentation]    Ensure the VM is reachable from ssh as tests would require. This keyword will use publickey authentication
 385     ${output} =    Execute Command on VM Instance with PublicKey Auth    ${net_name}    ${vm_ip}    ifconfig    user=${user}    idfile=${idfile}
 386     ...    console=${console}
 387     BuiltIn.Should Contain    ${output}    ${vm_ip}
 388
 389 Check If Instance Is Ready For Ssh Login Using Password
 390     [Arguments]    ${net_name}    ${vm_ip}    ${user}=cirros    ${password}=cubswin:)    ${console}=cirros
 391     [Documentation]    Ensure the VM is reachable from ssh as tests would require. This keyword will use password authentication
 392     ${output} =    Execute Command on VM Instance    ${net_name}    ${vm_ip}    ifconfig    ${user}    ${password}
 393     ...    console=${console}
 394     BuiltIn.Should Contain    ${output}    ${vm_ip}
 395
 396 Get VM IPs
 397     [Arguments]    @{vms}
 398     [Documentation]    Get the instance IP addresses and nameserver address for the list of given vms.
 399     ...    First poll for the vm instance to be in the active state, then poll for the vm ip address and nameserver.
 400     ...    Get VM IPs returns two things: [0] a list of the ips for the vms passed to this keyword (may contain values
 401     ...    of None) and [1] the dhcp ip address found in the last vm checked.
 402     ...    TODO: there is a potential issue for a caller that passes in VMs belonging to different networks that
 403     ...    may have different dhcp server addresses. Not sure what TODO about that, but noting it here for reference.
 404     @{vm_ips}    BuiltIn.Create List    @{EMPTY}
 405     FOR    ${vm}    IN    @{vms}
 406         OpenStackOperations.Poll VM Is ACTIVE    ${vm}
 407         ${status}    ${ips_and_console_log}    BuiltIn.Run Keyword And Ignore Error    BuiltIn.Wait Until Keyword Succeeds    180s    15s
 408         ...    OpenStackOperations.Get VM IP    true    ${vm}
 409         # If there is trouble with Get VM IP, the status will be FAIL and the return value will be a string of what went
 410         # wrong. We need to handle both the PASS and FAIL cases. In the FAIL case we know we wont have access to the
 411         # console log, as it would not be returned; so we need to grab it again to log it. We also can append 'None' to
 412         # the vm ip list if status is FAIL.
 413         BuiltIn.Run Keyword If    "${status}" == "PASS"    BuiltIn.Log    ${ips_and_console_log[2]}
 414         BuiltIn.Run Keyword If    "${status}" == "PASS"    Collections.Append To List    ${vm_ips}    ${ips_and_console_log[0]}
 415         BuiltIn.Run Keyword If    "${status}" == "FAIL"    Collections.Append To List    ${vm_ips}    None
 416         ${vm_console_output} =    BuiltIn.Run Keyword If    "${status}" == "FAIL"    OpenStack CLI    openstack console log show ${vm}
 417         BuiltIn.Run Keyword If    "${status}" == "FAIL"    BuiltIn.Log    ${vm_console_output}
 418     END
 419     OpenStackOperations.Copy DHCP Files From Control Node
 420     [Return]    @{vm_ips}    ${ips_and_console_log[1]}
 421
 422 Get All VM IP Addresses
 423     [Arguments]    ${conn_id}    ${vm_name}
 424     [Documentation]    Show information of a given two port VM and grep for two ip address. VM name should be sent as arguments.
 425     SSHLibrary.Switch Connection    ${conn_id}
 426     ${cmd} =    BuiltIn.Set Variable    openstack server show ${vm_name}
 427     ${output} =    OpenStackOperations.OpenStack CLI    ${cmd}
 428     BuiltIn.Log    ${output}
 429     ${address_output} =    OpenStackOperations.OpenStack CLI    ${cmd} | grep "addresses" | awk '{print $4$5}'
 430     @{vm_ips} =    String.Get Regexp Matches    ${address_output}    ${REGEX_IPV4}
 431     [Return]    @{vm_ips}
 432
 433 Get Subnet Gateway Ip
 434     [Arguments]    ${subnet_name}
 435     [Documentation]    Show information of a subnet and grep for subnet gateway ip address
 436     ${output} =    OpenStackOperations.OpenStack CLI    openstack subnet show ${subnet_name} | grep gateway_ip | awk '{print $4}'
 437     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 438     ${matches} =    Collections.Get Matches    ${splitted_output}    regexp=(\\d\.)+
 439     ${subnet_gateway_ip} =    String.Strip String    ${matches[0]}    characters=','
 440     [Return]    ${subnet_gateway_ip}
 441
 442 Collect VM IPv6 SLAAC Addresses
 443     [Arguments]    ${fail_on_none}    ${vm_list}    ${network}    ${subnet}
 444     [Documentation]    For each VM parse output of "openstack server show" to get its IPv6 address from Neutron DB.
 445     ...    Then try to connect to each VM by SSH and execute there "ip -6 a" command. This double-check allows to
 446     ...    obtain and compare IP info (Neutron DB vs dnsmasque/ODL DHCP) and to test L2 connectivity as well.
 447     ...    Returns an empty list if no IPv6 addresses found or if SSH connection fails.
 448     ...    Otherwise, returns a list of IPv6 addresses.
 449     ${ipv6_list} =    BuiltIn.Create List    @{EMPTY}
 450     FOR    ${vm}    IN    @{vm_list}
 451         ${output} =    OpenStack CLI    openstack server show ${vm} -f shell
 452         ${pattern} =    String.Replace String    ${subnet}    ::/64    (:[a-f0-9]{,4}){,4}
 453         @{vm_ipv6} =    String.Get Regexp Matches    ${output}    ${pattern}
 454         ${vm_ip_length} =    BuiltIn.Get Length    ${vm_ipv6}[0]
 455         ${ipv6_data_from_vm} =    BuiltIn.Run Keyword If    ${vm_ip_length}>0    OpenStackOperations.Execute Command on VM Instance    ${network}    ${vm_ipv6[0]}
 456         ...    ip -6 a
 457         @{ipv6} =    String.Get Regexp Matches    ${ipv6_data_from_vm}    ${pattern}
 458         ${ipv6_addr_list_length}    BuiltIn.Get Length    @{ipv6}
 459         BuiltIn.Run Keyword If    ${ipv6_addr_list_length}>0    Collections.Append To List    ${ipv6_list}    ${ipv6[0]}
 460         ...    ELSE    Collections.Append To List    ${ipv6_list}    None
 461     END
 462     [Return]    ${ipv6_list}
 463
 464 View Vm Console
 465     [Arguments]    ${vm_instance_names}
 466     [Documentation]    View Console log of the created vm instances using nova show.
 467     FOR    ${vm}    IN    @{vm_instance_names}
 468         ${output} =    OpenStack CLI    openstack server show ${vm}
 469         ${output} =    OpenStack CLI    openstack console log show ${vm}
 470     END
 471
 472 Ping Vm From DHCP Namespace
 473     [Arguments]    ${net_name}    ${vm_ip}
 474     [Documentation]    Reach all Vm Instance with the net id of the Netowrk.
 475     OpenStackOperations.Get ControlNode Connection
 476     ${net_id} =    OpenStackOperations.Get Net Id    ${net_name}
 477     ${output} =    DevstackUtils.Write Commands Until Prompt And Log    sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip}    20s
 478     BuiltIn.Should Contain    ${output}    64 bytes
 479
 480 Ping From DHCP Should Not Succeed
 481     [Arguments]    ${net_name}    ${vm_ip}
 482     [Documentation]    Should Not Reach Vm Instance with the net id of the Netowrk.
 483     Return From Keyword If    "skip_if_${SECURITY_GROUP_MODE}" in @{TEST_TAGS}
 484     OpenStackOperations.Get ControlNode Connection
 485     ${net_id} =    OpenStackOperations.Get Net Id    ${net_name}
 486     ${output} =    DevstackUtils.Write Commands Until Prompt And Log    sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip}    20s
 487     BuiltIn.Should Not Contain    ${output}    64 bytes
 488
 489 Ping Vm From Control Node
 490     [Arguments]    ${vm_floating_ip}    ${additional_args}=${EMPTY}
 491     [Documentation]    Ping VM floating IP from control node
 492     OpenStackOperations.Get ControlNode Connection
 493     ${output} =    DevstackUtils.Write Commands Until Prompt And Log    ping ${additional_args} -c 3 ${vm_floating_ip}    20s
 494     BuiltIn.Should Contain    ${output}    64 bytes
 495
 496 Curl Metadata Server
 497     [Documentation]    Ping to the expected destination ip.
 498     ${output} =    Utils.Write Commands Until Expected Prompt    curl -i http://169.254.169.254    ${OS_SYSTEM_PROMPT}
 499     DevstackUtils.Write Commands Until Prompt    exit
 500     BuiltIn.Should Contain    ${output}    200
 501
 502 Close Vm Instance
 503     [Documentation]    Exit the vm instance.
 504     ${output} =    DevstackUtils.Write Commands Until Prompt And Log    exit
 505
 506 Check If Console Is VmInstance
 507     [Arguments]    ${console}=cirros
 508     [Documentation]    Check if the session has been able to login to the VM instance
 509     ${output} =    Utils.Write Commands Until Expected Prompt    id    ${OS_SYSTEM_PROMPT}
 510     BuiltIn.Should Contain    ${output}    ${console}
 511
 512 Exit From Vm Console
 513     [Arguments]    ${console}=cirros
 514     [Documentation]    Check if the session has been able to login to the VM instance and exit the instance
 515     ${rcode} =    BuiltIn.Run Keyword And Return Status    OpenStackOperations.Check If Console Is VmInstance    ${console}
 516     BuiltIn.Run Keyword If    ${rcode}    DevstackUtils.Write Commands Until Prompt    exit
 517
 518 Check Ping
 519     [Arguments]    ${ip_address}    ${ttl}=64    ${ping_tries}=3
 520     [Documentation]    Run Ping command on the IP available as argument
 521     ${ethertype} =    String.Get Regexp Matches    ${ip_address}    ${IP_REGEX}
 522     ${ping} =    BuiltIn.Set Variable If    ${ethertype}    ping    ping6
 523     ${cmd} =    BuiltIn.Set Variable    rc=0; for count in `seq 1 ${ping_tries}`; do ${ping} -W1 -t${ttl} -c1 ${ip_address}; rc=$?; if [ $rc -eq 0 ]; then break; fi; done; echo ping_rc=$rc
 524     ${output} =    Utils.Write Commands Until Expected Regexp    ${cmd}    ping_rc=\\d+    120
 525     BuiltIn.Log    output: ${output}
 526     BuiltIn.Should Contain    ${output}    64 bytes
 527
 528 Check No Ping
 529     [Arguments]    ${ip_address}    ${ttl}=64
 530     [Documentation]    Run Ping command to the IP given as argument, executing 3 times and expecting NOT to see "64 bytes"
 531     ${output} =    Utils.Write Commands Until Expected Prompt    ping -t ${ttl} -c 3 ${ip_address}    ${OS_SYSTEM_PROMPT}
 532     BuiltIn.Should Not Contain    ${output}    64 bytes
 533
 534 Check Metadata Access
 535     [Documentation]    Try curl on the Metadataurl and check if it is okay
 536     ${output} =    Utils.Write Commands Until Expected Prompt    curl -i http://169.254.169.254    ${OS_SYSTEM_PROMPT}
 537     BuiltIn.Should Contain    ${output}    200
 538
 539 Execute Command on VM Instance
 540     [Arguments]    ${net_name}    ${vm_ip}    ${cmd}    ${user}=cirros    ${password}=cubswin:)    ${cmd_timeout}=30s
 541     ...    ${console}=cirros
 542     [Documentation]    Login to the vm instance using ssh in the network, executes a command inside the VM and returns the ouput.
 543     OpenStackOperations.Get ControlNode Connection
 544     ${net_id} =    OpenStackOperations.Get Net Id    ${net_name}
 545     ${output} =    Utils.Write Commands Until Expected Prompt    sudo ip netns exec qdhcp-${net_id} ssh ${user}@${vm_ip} -o MACs=hmac-sha1 -o ConnectTimeout=5 -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o PreferredAuthentications=password    password:
 546     ${output} =    Utils.Write Commands Until Expected Prompt    ${password}    ${OS_SYSTEM_PROMPT}
 547     ${rcode} =    BuiltIn.Run Keyword And Return Status    OpenStackOperations.Check If Console Is VmInstance    ${console}
 548     ${output} =    BuiltIn.Run Keyword If    ${rcode}    Utils.Write Commands Until Expected Prompt    ${cmd}    ${OS_SYSTEM_PROMPT}    timeout=${cmd_timeout}
 549     [Teardown]    Exit From Vm Console    ${console}
 550     [Return]    ${output}
 551
 552 Execute Command on VM Instance With PublicKey Auth
 553     [Arguments]    ${net_name}    ${vm_ip}    ${cmd}    ${user}=centos    ${idfile}=/tmp/odlkey    ${console}=cirros
 554     [Documentation]    Login to the vm instance using ssh publickey in the network, executes a command inside the VM and returns the ouput.
 555     OpenStackOperations.Get ControlNode Connection
 556     ${net_id} =    OpenStackOperations.Get Net Id    ${net_name}
 557     ${output} =    Utils.Write Commands Until Expected Prompt    sudo ip netns exec qdhcp-${net_id} ssh -i ${idfile} ${user}@${vm_ip} -o MACs=hmac-sha1 -o ConnectTimeout=5 -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o PreferredAuthentications=publickey    prompt=${OS_SYSTEM_PROMPT}    timeout=60s
 558     ${rcode} =    BuiltIn.Run Keyword And Return Status    OpenStackOperations.Check If Console Is VmInstance    ${console}
 559     ${output} =    BuiltIn.Run Keyword If    ${rcode}    Utils.Write Commands Until Expected Prompt    ${cmd}    ${OS_SYSTEM_PROMPT}
 560     [Teardown]    Exit From Vm Console    ${console}
 561     [Return]    ${output}
 562
 563 Copy File To VM Instance With PublicKey Auth
 564     [Arguments]    ${net_name}    ${vm_ip}    ${file_to_copy}    ${user}=centos    ${idfile}=/tmp/odlkey
 565     [Documentation]    Login to the vm instance using ssh publickey in the network, executes a command inside the VM and returns the ouput.
 566     OpenStackOperations.Get ControlNode Connection
 567     ${net_id} =    OpenStackOperations.Get Net Id    ${net_name}
 568     ${rc} =    SSHLibrary.Execute Command    sudo ip netns exec qdhcp-${net_id} scp -i ${idfile} -o MACs=hmac-sha1 -o ConnectTimeout=5 -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o PreferredAuthentications=publickey ${file_to_copy} ${user}@${vm_ip}:/tmp/    return_stdout=False    return_rc=True
 569     BuiltIn.Should Be True    '${rc}' == '0'
 570
 571 Test Operations From Vm Instance
 572     [Arguments]    ${net_name}    ${src_ip}    ${dest_ips}    ${user}=cirros    ${password}=cubswin:)    ${ttl}=64
 573     ...    ${ping_should_succeed}=True    ${check_metadata}=True    ${console}=cirros    ${ping_tries}=3
 574     [Documentation]    Login to the vm instance using ssh in the network.
 575     OpenStackOperations.Get ControlNode Connection
 576     ${net_id} =    OpenStackOperations.Get Net Id    ${net_name}
 577     ${output} =    Utils.Write Commands Until Expected Prompt    sudo ip netns exec qdhcp-${net_id} ssh -o MACs=hmac-sha1 -o ConnectTimeout=5 -o StrictHostKeyChecking=no ${user}@${src_ip} -o UserKnownHostsFile=/dev/null    password:    10s
 578     ${output} =    Utils.Write Commands Until Expected Prompt    ${password}    ${OS_SYSTEM_PROMPT}
 579     ${rcode} =    BuiltIn.Run Keyword And Return Status    OpenStackOperations.Check If Console Is VmInstance    ${console}
 580     BuiltIn.Run Keyword If    ${rcode}    Utils.Write Commands Until Expected Prompt    ifconfig    ${OS_SYSTEM_PROMPT}
 581     BuiltIn.Run Keyword If    ${rcode}    Utils.Write Commands Until Expected Prompt    route -n    ${OS_SYSTEM_PROMPT}
 582     BuiltIn.Run Keyword If    ${rcode}    Utils.Write Commands Until Expected Prompt    route -A inet6    ${OS_SYSTEM_PROMPT}
 583     BuiltIn.Run Keyword If    ${rcode}    Utils.Write Commands Until Expected Prompt    arp -an    ${OS_SYSTEM_PROMPT}
 584     BuiltIn.Run Keyword If    ${rcode}    Utils.Write Commands Until Expected Prompt    ip -f inet6 neigh show    ${OS_SYSTEM_PROMPT}
 585     FOR    ${dest_ip}    IN    @{dest_ips}
 586         ${string_empty} =    BuiltIn.Run Keyword And Return Status    Should Be Empty    ${dest_ip}
 587         BuiltIn.Run Keyword If    ${string_empty}    Continue For Loop
 588         BuiltIn.Run Keyword If    ${rcode} and "${ping_should_succeed}" == "True"    OpenStackOperations.Check Ping    ${dest_ip}    ttl=${ttl}    ping_tries=${ping_tries}
 589         ...    ELSE    OpenStackOperations.Check No Ping    ${dest_ip}    ttl=${ttl}
 590     END
 591     ${ethertype} =    String.Get Regexp Matches    ${src_ip}    ${IP_REGEX}
 592     BuiltIn.Run Keyword If    ${rcode} and "${check_metadata}" and ${ethertype} == "True"    OpenStackOperations.Check Metadata Access
 593     [Teardown]    Exit From Vm Console    ${console}
 594
 595 Test Netcat Operations From Vm Instance
 596     [Arguments]    ${net_name}    ${vm_ip}    ${dest_ip}    ${additional_args}=${EMPTY}    ${port}=12345    ${user}=cirros
 597     ...    ${password}=cubswin:)
 598     [Documentation]    Use Netcat to test TCP/UDP connections to the controller
 599     ${client_data}    BuiltIn.Set Variable    Test Client Data
 600     ${server_data}    BuiltIn.Set Variable    Test Server Data
 601     OpenStackOperations.Get ControlNode Connection
 602     ${output} =    DevstackUtils.Write Commands Until Prompt And Log    ( ( echo "${server_data}" | sudo timeout 60 nc -l ${additional_args} ${port} ) & )
 603     ${output} =    DevstackUtils.Write Commands Until Prompt And Log    sudo netstat -nlap | grep ${port}
 604     ${nc_output} =    OpenStackOperations.Execute Command on VM Instance    ${net_name}    ${vm_ip}    sudo echo "${client_data}" | nc -v -w 5 ${additional_args} ${dest_ip} ${port}
 605     BuiltIn.Log    ${output}
 606     ${output} =    OpenStackOperations.Execute Command on VM Instance    ${net_name}    ${vm_ip}    sudo route -n
 607     BuiltIn.Log    ${output}
 608     ${output} =    OpenStackOperations.Execute Command on VM Instance    ${net_name}    ${vm_ip}    sudo arp -an
 609     BuiltIn.Log    ${output}
 610     BuiltIn.Should Match Regexp    ${nc_output}    ${server_data}
 611
 612 Ping Other Instances
 613     [Arguments]    ${list_of_external_dst_ips}    ${console}=cirros
 614     [Documentation]    Check reachability with other network's instances.
 615     ${rcode} =    BuiltIn.Run Keyword And Return Status    OpenStackOperations.Check If Console Is VmInstance    ${console}
 616     FOR    ${dest_ip}    IN    @{list_of_external_dst_ips}
 617         OpenStackOperations.Check Ping    ${dest_ip}
 618     END
 619
 620 Create Router
 621     [Arguments]    ${router_name}
 622     [Documentation]    Create Router and Add Interface to the subnets.
 623     ${output} =    OpenStack CLI    openstack router create ${router_name}
 624
 625 List Routers
 626     [Documentation]    List Routers and return output with neutron client.
 627     ${output} =    OpenStack CLI    openstack router list -f value
 628     [Return]    ${output}
 629
 630 Add Router Interface
 631     [Arguments]    ${router_name}    ${interface_name}
 632     ${output} =    OpenStack CLI    openstack router add subnet ${router_name} ${interface_name}
 633
 634 Show Router Interface
 635     [Arguments]    ${router_name}
 636     [Documentation]    List Routers interface associated with given Router and return output with neutron client.
 637     ${output} =    OpenStack CLI    openstack port list --router ${router_name} -f value
 638     [Return]    ${output}
 639
 640 Add Router Gateway
 641     [Arguments]    ${router_name}    ${external_network_name}    ${additional_args}=${EMPTY}
 642     ${output} =    OpenStack CLI    openstack router set ${router_name} --external-gateway ${external_network_name} ${additional_args}
 643
 644 Remove Interface
 645     [Arguments]    ${router_name}    ${interface_name}
 646     [Documentation]    Remove Interface to the subnets.
 647     ${output} =    OpenStack CLI    openstack router remove subnet ${router_name} ${interface_name}
 648
 649 Remove Gateway
 650     [Arguments]    ${router_name}
 651     [Documentation]    Remove external gateway from the router.
 652     ${output} =    OpenStack CLI    openstack router unset ${router_name} --external-gateway
 653
 654 Update Router
 655     [Arguments]    ${router_name}    ${cmd}
 656     [Documentation]    Update the router with the command. Router name and command should be passed as argument.
 657     ${output} =    OpenStack CLI    openstack router set ${router_name} ${cmd}
 658
 659 Show Router
 660     [Arguments]    ${router_name}    ${additional_args}=${EMPTY}
 661     [Documentation]    Show information of a given router. Router name and optional fields should be sent as arguments.
 662     ${output} =    OpenStack CLI    openstack router show ${router_name} ${additional_args}
 663     [Return]    ${output}
 664
 665 Delete Router
 666     [Arguments]    ${router_name}
 667     [Documentation]    Delete Router and Interface to the subnets.
 668     ${output} =    OpenStack CLI    openstack router delete ${router_name}
 669
 670 Get DumpFlows And Ovsconfig
 671     [Arguments]    ${conn_id}
 672     [Documentation]    Get the OvsConfig and Flow entries from OVS from the Openstack Node
 673     SSHLibrary.Switch Connection    ${conn_id}
 674     Utils.Write Commands Until Expected Prompt    ip -o link    ${DEFAULT_LINUX_PROMPT_STRICT}
 675     Utils.Write Commands Until Expected Prompt    ip -o addr    ${DEFAULT_LINUX_PROMPT_STRICT}
 676     Utils.Write Commands Until Expected Prompt    ip route    ${DEFAULT_LINUX_PROMPT_STRICT}
 677     Utils.Write Commands Until Expected Prompt    arp -an    ${DEFAULT_LINUX_PROMPT_STRICT}
 678     ${nslist} =    Utils.Write Commands Until Expected Prompt    ip netns list | awk '{print $1}'    ${DEFAULT_LINUX_PROMPT_STRICT}
 679     @{lines}    Split To Lines    ${nslist}    end=-1
 680     FOR    ${line}    IN    @{lines}
 681         Utils.Write Commands Until Expected Prompt    sudo ip netns exec ${line} ip -o link    ${DEFAULT_LINUX_PROMPT_STRICT}
 682         Utils.Write Commands Until Expected Prompt    sudo ip netns exec ${line} ip -o addr    ${DEFAULT_LINUX_PROMPT_STRICT}
 683         Utils.Write Commands Until Expected Prompt    sudo ip netns exec ${line} ip route    ${DEFAULT_LINUX_PROMPT_STRICT}
 684     END
 685     Utils.Write Commands Until Expected Prompt    sudo ovs-vsctl show    ${DEFAULT_LINUX_PROMPT_STRICT}
 686     Utils.Write Commands Until Expected Prompt    sudo ovs-vsctl list Open_vSwitch    ${DEFAULT_LINUX_PROMPT_STRICT}
 687     Utils.Write Commands Until Expected Prompt    sudo ovs-ofctl show ${INTEGRATION_BRIDGE} -OOpenFlow13    ${DEFAULT_LINUX_PROMPT_STRICT}
 688     Utils.Write Commands Until Expected Prompt    sudo ovs-ofctl dump-flows ${INTEGRATION_BRIDGE} -OOpenFlow13    ${DEFAULT_LINUX_PROMPT_STRICT}
 689     Utils.Write Commands Until Expected Prompt    sudo ovs-ofctl dump-groups ${INTEGRATION_BRIDGE} -OOpenFlow13    ${DEFAULT_LINUX_PROMPT_STRICT}
 690     Utils.Write Commands Until Expected Prompt    sudo ovs-ofctl dump-group-stats ${INTEGRATION_BRIDGE} -OOpenFlow13    ${DEFAULT_LINUX_PROMPT_STRICT}
 691
 692 Get ControlNode Connection
 693     SSHLibrary.Switch Connection    ${OS_CNTL_CONN_ID}
 694     [Return]    ${OS_CNTL_CONN_ID}
 695
 696 Get OvsDebugInfo
 697     [Documentation]    Get the OvsConfig and Flow entries from all Openstack nodes
 698     FOR    ${conn_id}    IN    @{OS_ALL_CONN_IDS}
 699         OpenStackOperations.Get DumpFlows And Ovsconfig    ${conn_id}
 700     END
 701
 702 Get Test Teardown Debugs
 703     [Arguments]    ${test_name}=${SUITE_NAME}.${TEST_NAME}    ${fail}=${FAIL_ON_EXCEPTIONS}
 704     ODLTools.Get All    node_ip=${HA_PROXY_IP}    test_name=${test_name}
 705     OpenStackOperations.Get OvsDebugInfo
 706     BuiltIn.Run Keyword And Ignore Error    DataModels.Get Model Dump    ${HA_PROXY_IP}    ${netvirt_data_models}
 707     KarafKeywords.Fail If Exceptions Found During Test    ${test_name}    fail=${fail}
 708     FOR    ${i}    IN RANGE    ${NUM_ODL_SYSTEM}
 709         BuiltIn.Run Keyword And Ignore Error    Issue_Command_On_Karaf_Console    trace:transactions    ${ODL_SYSTEM_${i+1}_IP}
 710     END
 711
 712 Get Suite Debugs
 713     Get Test Teardown Debugs    test_name=${SUITE_NAME}    fail=False
 714
 715 Get Test Teardown Debugs For SFC
 716     [Arguments]    ${test_name}=${TEST_NAME}
 717     BuiltIn.Run Keyword And Ignore Error    DataModels.Get Model Dump    ${HA_PROXY_IP}    ${netvirt_sfc_data_models}
 718
 719 Show Debugs
 720     [Arguments]    @{vm_indices}
 721     [Documentation]    Run these commands for debugging, it can list state of VM instances and ip information in control node
 722     OpenStackOperations.Get ControlNode Connection
 723     ${output} =    DevstackUtils.Write Commands Until Prompt And Log    sudo ip netns list
 724     FOR    ${index}    IN    @{vm_indices}
 725         ${rc}    ${output} =    OperatingSystem.Run And Return Rc And Output    nova show ${index}
 726         BuiltIn.Log    ${output}
 727     END
 728     OpenStackOperations.List Nova VMs
 729     OpenStackOperations.List Routers
 730     OpenStackOperations.List Networks
 731     OpenStackOperations.List Subnets
 732     OpenStackOperations.List Ports
 733     OpenStackOperations.List Security Groups
 734
 735 List Security Groups
 736     [Documentation]    Logging keyword to display all security groups using the openstack cli. Assumes openstack
 737     ...    credentials are already sourced
 738     ${output} =    OpenStack CLI    openstack security group list
 739     [Return]    ${output}
 740
 741 Neutron Security Group Show
 742     [Arguments]    ${SecurityGroupRuleName}
 743     [Documentation]    Displays the neutron security group configurations that belongs to a given neutron security group name
 744     ${output} =    OpenStack CLI    openstack security group show ${SecurityGroupRuleName}
 745     [Return]    ${output}
 746
 747 Neutron Port Show
 748     [Arguments]    ${PortName}
 749     [Documentation]    Display the port configuration that belong to a given neutron port
 750     ${output} =    OpenStack CLI    openstack port show ${PortName}
 751     [Return]    ${output}
 752
 753 Neutron Security Group Create
 754     [Arguments]    ${SecurityGroupName}    ${additional_args}=${EMPTY}
 755     [Documentation]    Create a security group with specified name ,description & protocol value according to security group template
 756     OpenStackOperations.Get ControlNode Connection
 757     ${output} =    OpenStack CLI    openstack security group create ${SecurityGroupName} ${additional_args}
 758     ${sgp_id} =    BuiltIn.Should Match Regexp    ${output}    ${REGEX_UUID}
 759     [Return]    ${output}    ${sgp_id}
 760
 761 Neutron Security Group Update
 762     [Arguments]    ${SecurityGroupName}    ${additional_args}=${EMPTY}
 763     [Documentation]    Updating security groups
 764     ${output} =    OpenStack CLI    openstack security group set ${SecurityGroupName} ${additional_args}
 765     [Return]    ${output}
 766
 767 Delete SecurityGroup
 768     [Arguments]    ${sg_name}
 769     [Documentation]    Delete Security group
 770     ${output} =    OpenStack CLI    openstack security group delete ${sg_name}
 771
 772 Neutron Security Group Rule Create
 773     [Arguments]    ${Security_group_name}    &{Kwargs}
 774     [Documentation]    Creates neutron security rule with Openstack CLI with or without optional params, here security group name is mandatory args, rule with optional params can be created by passing the optional args values ex: direction=${INGRESS_EGRESS}, Then these optional params are BuiltIn.Catenated with mandatory args, example of usage: "OpenStack Neutron Security Group Rule Create ${SGP_SSH} direction=${RULE_PARAMS[0]} ethertype=${RULE_PARAMS[1]} ..."
 775     BuiltIn.Run Keyword If    ${Kwargs}    BuiltIn.Log    ${Kwargs}
 776     ${description}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    description    default=${None}
 777     ${direction}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    direction    default=${None}
 778     ${ethertype}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    ethertype    default=${None}
 779     ${port_range_max}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    port_range_max    default=${None}
 780     ${port_range_min}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    port_range_min    default=${None}
 781     ${protocol}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    protocol    default=${None}
 782     ${remote_group_id}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    remote_group_id    default=${None}
 783     ${remote_ip_prefix}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    remote_ip_prefix    default=${None}
 784     ${remote_ip}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    remote_ip    default=${None}
 785     ${cmd} =    BuiltIn.Set Variable    openstack security group rule create ${Security_group_name}
 786     ${cmd} =    BuiltIn.Run Keyword If    '${description}'!='None'    BuiltIn.Catenate    ${cmd}    --description ${description}
 787     ...    ELSE    BuiltIn.Catenate    ${cmd}
 788     ${cmd} =    BuiltIn.Run Keyword If    '${direction}'!='None'    BuiltIn.Catenate    ${cmd}    --${direction}
 789     ...    ELSE    BuiltIn.Catenate    ${cmd}
 790     ${cmd} =    BuiltIn.Run Keyword If    '${ethertype}'!='None'    BuiltIn.Catenate    ${cmd}    --ethertype ${ethertype}
 791     ...    ELSE    BuiltIn.Catenate    ${cmd}
 792     ${cmd} =    BuiltIn.Run Keyword If    '${port_range_min}'!='None' and '${port_range_max}'!='None'    BuiltIn.Catenate    ${cmd}    --dst-port ${port_range_min}:${port_range_max}
 793     ...    ELSE IF    '${port_range_max}'!='None'    BuiltIn.Catenate    ${cmd}    --dst-port ${port_range_max}
 794     ...    ELSE IF    '${port_range_min}'!='None'    BuiltIn.Catenate    ${cmd}    --dst-port ${port_range_min}
 795     ...    ELSE    BuiltIn.Catenate    ${cmd}
 796     ${cmd} =    BuiltIn.Run Keyword If    '${protocol}'!='None'    BuiltIn.Catenate    ${cmd}    --protocol ${protocol}
 797     ...    ELSE    BuiltIn.Catenate    ${cmd}
 798     ${cmd} =    BuiltIn.Run Keyword If    '${remote_group_id}'!='None'    BuiltIn.Catenate    ${cmd}    --remote-group ${remote_group_id}
 799     ...    ELSE    BuiltIn.Catenate    ${cmd}
 800     ${cmd} =    BuiltIn.Run Keyword If    '${remote_ip_prefix}'!='None'    BuiltIn.Catenate    ${cmd}    --src-ip ${remote_ip_prefix}
 801     ...    ELSE    BuiltIn.Catenate    ${cmd}
 802     ${cmd} =    BuiltIn.Run Keyword If    '${remote_ip}'!='None'    BuiltIn.Catenate    ${cmd}    --remote-ip ${remote_ip}
 803     ...    ELSE    BuiltIn.Catenate    ${cmd}
 804     ${output} =    OpenStack CLI    ${cmd}
 805     ${rule_id} =    BuiltIn.Should Match Regexp    ${output}    ${REGEX_UUID}
 806     [Return]    ${output}    ${rule_id}
 807
 808 Security Group Create Without Default Security Rules
 809     [Arguments]    ${sg_name}    ${additional_args}=${EMPTY}
 810     [Documentation]    Create Neutron Security Group with no default rules, using specified name and optional arguments.
 811     OpenStackOperations.Neutron Security Group Create    ${sg_name}    ${additional_args}
 812     Delete All Security Group Rules    ${sg_name}
 813
 814 Delete All Security Group Rules
 815     [Arguments]    ${sg_name}
 816     [Documentation]    Delete all security rules from a specified security group
 817     ${sg_rules_output} =    OpenStack CLI    openstack security group rule list ${sg_name} -cID -fvalue
 818     @{sg_rules} =    String.Split String    ${sg_rules_output}    \n
 819     FOR    ${rule}    IN    @{sg_rules}
 820         ${output} =    OpenStack CLI    openstack security group rule delete ${rule}
 821     END
 822
 823 Create Allow All SecurityGroup
 824     [Arguments]    ${sg_name}    ${ether_type}=IPv4    ${dual}=False
 825     [Documentation]    Allow all TCP/UDP/ICMP packets for this suite
 826     OpenStackOperations.Neutron Security Group Create    ${sg_name}
 827     OpenStackOperations.Neutron Security Group Rule Create    ${sg_name}    direction=ingress    ethertype=${ether_type}    port_range_max=65535    port_range_min=1    protocol=tcp
 828     OpenStackOperations.Neutron Security Group Rule Create    ${sg_name}    direction=egress    ethertype=${ether_type}    port_range_max=65535    port_range_min=1    protocol=tcp
 829     OpenStackOperations.Neutron Security Group Rule Create    ${sg_name}    direction=ingress    ethertype=${ether_type}    protocol=icmp
 830     OpenStackOperations.Neutron Security Group Rule Create    ${sg_name}    direction=egress    ethertype=${ether_type}    protocol=icmp
 831     OpenStackOperations.Neutron Security Group Rule Create    ${sg_name}    direction=ingress    ethertype=${ether_type}    port_range_max=65535    port_range_min=1    protocol=udp
 832     OpenStackOperations.Neutron Security Group Rule Create    ${sg_name}    direction=egress    ethertype=${ether_type}    port_range_max=65535    port_range_min=1    protocol=udp
 833     BuiltIn.Run Keyword If    "${dual}"=="True"    Run Keywords    OpenStackOperations.Neutron Security Group Rule Create    ${sg_name}    direction=ingress    ethertype=IPv6
 834     ...    port_range_max=65535    port_range_min=1    protocol=tcp
 835     ...    AND    OpenStackOperations.Neutron Security Group Rule Create    ${sg_name}    direction=egress    ethertype=IPv6    port_range_max=65535
 836     ...    port_range_min=1    protocol=tcp
 837     ...    AND    OpenStackOperations.Neutron Security Group Rule Create    ${sg_name}    direction=ingress    ethertype=IPv6    protocol=icmp
 838     ...    AND    OpenStackOperations.Neutron Security Group Rule Create    ${sg_name}    direction=egress    ethertype=IPv6    protocol=icmp
 839     ...    AND    OpenStackOperations.Neutron Security Group Rule Create    ${sg_name}    direction=ingress    ethertype=IPv6    port_range_max=65535
 840     ...    port_range_min=1    protocol=udp
 841     ...    AND    OpenStackOperations.Neutron Security Group Rule Create    ${sg_name}    direction=egress    ethertype=IPv6    port_range_max=65535
 842     ...    port_range_min=1    protocol=udp
 843
 844 Create Neutron Port With Additional Params
 845     [Arguments]    ${network_name}    ${port_name}    ${additional_args}=${EMPTY}
 846     [Documentation]    Create Port With given additional parameters
 847     ${rc}    ${output} =    OperatingSystem.Run And Return Rc And Output    neutron -v port-create ${network_name} --name ${port_name} ${additional_args}
 848     BuiltIn.Log    ${output}
 849     BuiltIn.Should Be True    '${rc}' == '0'
 850     ${port_id} =    BuiltIn.Should Match Regexp    ${OUTPUT}    ${REGEX_UUID}
 851     [Return]    ${OUTPUT}    ${port_id}
 852
 853 Get Ports MacAddr
 854     [Arguments]    ${ports}
 855     [Documentation]    Retrieve the port MacAddr for the given list of port name and return the MAC address list.
 856     ${macs}    BuiltIn.Create List
 857     FOR    ${port}    IN    @{ports}
 858         ${mac} =    OpenStackOperations.Get Port Mac    ${port}
 859         Collections.Append To List    ${macs}    ${mac}
 860     END
 861     [Return]    ${macs}
 862
 863 Get Port Ip
 864     [Arguments]    ${port_name}
 865     [Documentation]    Keyword would return the IP of the ${port_name} received.
 866     ${output} =    OpenStack CLI    openstack port list | grep "${port_name}" | awk -F\\' '{print $2}'
 867     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 868     ${port_ip} =    Collections.Get from List    ${splitted_output}    0
 869     [Return]    ${port_ip}
 870
 871 Get Port Mac
 872     [Arguments]    ${port_name}
 873     [Documentation]    Keyword would return the MAC ID of the ${port_name} received.
 874     ${output} =    OpenStack CLI    openstack port show ${port_name} | grep mac_address | awk '{print $4}'
 875     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 876     ${port_mac} =    Collections.Get from List    ${splitted_output}    0
 877     [Return]    ${port_mac}
 878
 879 Get Port Mac Address From Ip
 880     [Arguments]    ${ip}
 881     [Documentation]    Retrieve the mac address for a port that matches any given ip.
 882     ${output} =    OpenStack CLI    openstack port list | grep -w ${ip} | awk '{print $5}'
 883     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 884     ${mac_addr} =    Collections.Get from List    ${splitted_output}    0
 885     [Return]    ${mac_addr}
 886
 887 Create L2Gateway
 888     [Arguments]    ${bridge_name}    ${intf_name}    ${gw_name}
 889     [Documentation]    Keyword to create an L2 Gateway ${gw_name} for bridge ${bridge_name} connected to interface ${intf_name} (Using Neutron CLI).
 890     ${rc}    ${l2gw_output} =    OperatingSystem.Run And Return Rc And Output    ${L2GW_CREATE} name=${bridge_name},interface_names=${intf_name} ${gw_name}
 891     BuiltIn.Log    ${l2gw_output}
 892     [Return]    ${l2gw_output}
 893
 894 Update L2Gateway
 895     [Arguments]    ${bridge_name}    ${gw_name}    ${intf_name_1}    ${intf_name_2}
 896     [Documentation]    Keyword to add {intf_name_list} to an existing L2 Gateway ${gw_name} (Using Neutron CLI).
 897     ${rc}    ${l2gw_output}=    Run And Return Rc And Output    ${L2GW_UPDATE} name=${bridge_name},interface_names="${intf_name_1};${intf_name_2}" ${gw_name}
 898     Log    ${l2gw_output}
 899     [Return]    ${l2gw_output}
 900
 901 Create L2Gateway Connection
 902     [Arguments]    ${gw_name}    ${net_name}
 903     [Documentation]    Keyword would create a new L2 Gateway Connection for ${gw_name} to ${net_name} (Using Neutron CLI).
 904     ${rc}    ${l2gw_output} =    OperatingSystem.Run And Return Rc And Output    ${L2GW_CONN_CREATE} ${gw_name} ${net_name}
 905     BuiltIn.Log    ${l2gw_output}
 906     BuiltIn.Should Be True    '${rc}' == '0'
 907     [Return]    ${l2gw_output}
 908
 909 Get All L2Gateway
 910     [Documentation]    Keyword to return all the L2 Gateways available (Using Neutron CLI).
 911     ${rc}    ${output} =    OperatingSystem.Run And Return Rc And Output    ${L2GW_GET_YAML}
 912     BuiltIn.Should Be True    '${rc}' == '0'
 913     [Return]    ${output}
 914
 915 Get All L2Gateway Connection
 916     [Documentation]    Keyword to return all the L2 Gateway connections available (Using Neutron CLI).
 917     ${rc}    ${output} =    OperatingSystem.Run And Return Rc And Output    ${L2GW_GET_CONN_YAML}
 918     BuiltIn.Should Be True    '${rc}' == '0'
 919     [Return]    ${output}
 920
 921 Get L2Gateway
 922     [Arguments]    ${gw_id}
 923     [Documentation]    Keyword to check if the ${gw_id} is available in the L2 Gateway list (Using Neutron CLI).
 924     ${rc}    ${output} =    OperatingSystem.Run And Return Rc And Output    ${L2GW_SHOW} ${gw_id}
 925     BuiltIn.Log    ${output}
 926     BuiltIn.Should Be True    '${rc}' == '0'
 927     [Return]    ${output}
 928
 929 Get L2gw Id
 930     [Arguments]    ${l2gw_name}
 931     [Documentation]    Keyword to retrieve the L2 Gateway ID for the ${l2gw_name} (Using Neutron CLI).
 932     ${rc}    ${output} =    OperatingSystem.Run And Return Rc And Output    ${L2GW_GET} | grep "${l2gw_name}" | awk '{print $2}'
 933     BuiltIn.Log    ${output}
 934     BuiltIn.Should Be True    '${rc}' == '0'
 935     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 936     ${l2gw_id} =    Collections.Get from List    ${splitted_output}    0
 937     [Return]    ${l2gw_id}
 938
 939 Get L2gw Connection Id
 940     [Arguments]    ${l2gw_name}
 941     [Documentation]    Keyword to retrieve the L2 Gateway Connection ID for the ${l2gw_name} (Using Neutron CLI).
 942     ${l2gw_id} =    OpenStackOperations.Get L2gw Id    ${l2gw_name}
 943     ${rc}    ${output} =    OperatingSystem.Run And Return Rc And Output    ${L2GW_GET_CONN} | grep "${l2gw_id}" | awk '{print $2}'
 944     BuiltIn.Should Be True    '${rc}' == '0'
 945     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 946     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 947     ${l2gw_conn_id} =    Collections.Get from List    ${splitted_output}    0
 948     [Return]    ${l2gw_conn_id}
 949
 950 Neutron Port List Rest
 951     [Documentation]    Keyword to get all ports details in Neutron (Using REST).
 952     ${resp} =    RequestsLibrary.Get Request    session    ${PORT_URL}
 953     BuiltIn.Log    ${resp.content}
 954     BuiltIn.Should Be Equal As Strings    ${resp.status_code}    200
 955     [Return]    ${resp.content}
 956
 957 Get Neutron Port Rest
 958     [Arguments]    ${port_id}
 959     [Documentation]    Keyword to get the specific port details in Neutron (Using REST).
 960     ${resp} =    RequestsLibrary.Get Request    session    ${CONFIG_API}/${GET_PORT_URL}/${port_id}
 961     BuiltIn.Log    ${resp.content}
 962     BuiltIn.Should Be Equal As Strings    ${resp.status_code}    200
 963     [Return]    ${resp.content}
 964
 965 Update Port Rest
 966     [Arguments]    ${port_id}    ${json_data}
 967     [Documentation]    Keyword to update ${port_id} with json data received in ${json_data} (Using REST).
 968     BuiltIn.Log    ${json_data}
 969     ${resp} =    RequestsLibrary.Put Request    session    ${CONFIG_API}/${GET_PORT_URL}/${port_id}    ${json_data}
 970     BuiltIn.Log    ${resp.content}
 971     BuiltIn.Should Be Equal As Strings    ${resp.status_code}    200
 972     [Return]    ${resp.content}
 973
 974 Get Neutron Network Rest
 975     [Arguments]    ${net_id}
 976     [Documentation]    Keyword to get the specific network details in Neutron (Using REST).
 977     ${resp} =    RequestsLibrary.Get Request    session    ${NETWORK_URL}/network/${net_id}
 978     BuiltIn.Log    ${resp.content}
 979     BuiltIn.Should Be Equal As Strings    ${resp.status_code}    200
 980     [Return]    ${resp.content}
 981
 982 Create And Configure Security Group
 983     [Arguments]    ${sg-name}
 984     [Documentation]    Create Security Group with given name, and default allow rules for TCP/UDP/ICMP protocols.
 985     OpenStackOperations.Neutron Security Group Create    ${sg-name}
 986     OpenStackOperations.Neutron Security Group Rule Create    ${sg-name}    direction=ingress    port_range_max=65535    port_range_min=1    protocol=tcp    remote_ip_prefix=0.0.0.0/0
 987     OpenStackOperations.Neutron Security Group Rule Create    ${sg-name}    direction=egress    port_range_max=65535    port_range_min=1    protocol=tcp    remote_ip_prefix=0.0.0.0/0
 988     OpenStackOperations.Neutron Security Group Rule Create    ${sg-name}    direction=ingress    protocol=icmp    remote_ip_prefix=0.0.0.0/0
 989     OpenStackOperations.Neutron Security Group Rule Create    ${sg-name}    direction=egress    protocol=icmp    remote_ip_prefix=0.0.0.0/0
 990     OpenStackOperations.Neutron Security Group Rule Create    ${sg-name}    direction=ingress    port_range_max=65535    port_range_min=1    protocol=udp    remote_ip_prefix=0.0.0.0/0
 991     OpenStackOperations.Neutron Security Group Rule Create    ${sg-name}    direction=egress    port_range_max=65535    port_range_min=1    protocol=udp    remote_ip_prefix=0.0.0.0/0
 992
 993 Add Security Group To VM
 994     [Arguments]    ${vm}    ${sg}
 995     [Documentation]    Add the security group provided to the given VM.
 996     ${output} =    OpenStack CLI    openstack server add security group ${vm} ${sg}
 997
 998 Remove Security Group From VM
 999     [Arguments]    ${vm}    ${sg}
1000     [Documentation]    Remove the security group provided to the given VM.
1001     OpenStackOperations.Get ControlNode Connection
1002     ${output} =    OpenStack CLI    openstack server remove security group ${vm} ${sg}
1003
1004 Create SFC Flow Classifier
1005     [Arguments]    ${name}    ${src_ip}    ${dest_ip}    ${protocol}    ${neutron_src_port}    ${args}=${EMPTY}
1006     [Documentation]    Create a flow classifier for SFC
1007     ${output} =    OpenStack CLI    openstack sfc flow classifier create --ethertype IPv4 --source-ip-prefix ${src_ip}/32 --destination-ip-prefix ${dest_ip}/32 --protocol ${protocol} --logical-source-port ${neutron_src_port} ${args} ${name}
1008     BuiltIn.Should Contain    ${output}    ${name}
1009     [Return]    ${output}
1010
1011 Delete SFC Flow Classifier
1012     [Arguments]    ${name}
1013     [Documentation]    Delete a SFC flow classifier
1014     ${output} =    OpenStack CLI    openstack sfc flow classifier delete ${name}
1015     [Return]    ${output}
1016
1017 Create SFC Port Pair
1018     [Arguments]    ${name}    ${port_in}    ${port_out}
1019     [Documentation]    Creates a neutron port pair for SFC
1020     ${output} =    OpenStack CLI    openstack sfc port pair create --ingress=${port_in} --egress=${port_out} ${name}
1021     BuiltIn.Should Contain    ${output}    ${name}
1022     [Return]    ${output}
1023
1024 Delete SFC Port Pair
1025     [Arguments]    ${name}
1026     [Documentation]    Delete a SFC port pair
1027     ${output} =    OpenStack CLI    openstack sfc port pair delete ${name}
1028     [Return]    ${output}
1029
1030 Create SFC Port Pair Group
1031     [Arguments]    ${name}    ${port_pair}
1032     [Documentation]    Creates a port pair group with a single port pair for SFC
1033     ${output} =    OpenStack CLI    openstack sfc port pair group create --port-pair ${port_pair} ${name}
1034     BuiltIn.Should Contain    ${output}    ${name}
1035     [Return]    ${output}
1036
1037 Create SFC Port Pair Group With Two Pairs
1038     [Arguments]    ${name}    ${port_pair1}    ${port_pair2}
1039     [Documentation]    Creates a port pair group with two port pairs for SFC
1040     ${output} =    OpenStack CLI    openstack sfc port pair group create --port-pair ${port_pair1} --port-pair ${port_pair2} ${name}
1041     BuiltIn.Should Contain    ${output}    ${name}
1042     [Return]    ${output}
1043
1044 Delete SFC Port Pair Group
1045     [Arguments]    ${name}
1046     [Documentation]    Delete a SFC port pair group
1047     OpenStackOperations.Get ControlNode Connection
1048     ${output} =    OpenStack CLI    openstack sfc port pair group delete ${name}
1049     [Return]    ${output}
1050
1051 Create SFC Port Chain
1052     [Arguments]    ${name}    ${args}=${EMPTY}
1053     [Documentation]    Creates a port pair chain with two port groups and a singel classifier.
1054     ${output} =    OpenStack CLI    openstack sfc port chain create ${name} ${args}
1055     BuiltIn.Should Contain    ${output}    ${name}
1056     [Return]    ${output}
1057
1058 Update SFC Port Chain With A New Flow Classifier
1059     [Arguments]    ${name}    ${fc}
1060     [Documentation]    Adds a Flow Classifier to a Port Chain
1061     ${output} =    OpenStack CLI    openstack sfc port chain set ${name} --flow-classifier ${fc}
1062     [Return]    ${output}
1063
1064 Update SFC Port Chain Removing A Flow Classifier
1065     [Arguments]    ${name}    ${fc}
1066     [Documentation]    Adds a Flow Classifier to a Port Chain
1067     ${output} =    OpenStack CLI    openstack sfc port chain unset ${name} --flow-classifier ${fc}
1068     [Return]    ${output}
1069
1070 Delete SFC Port Chain
1071     [Arguments]    ${name}
1072     [Documentation]    Delete a SFC port chain
1073     ${output} =    OpenStack CLI    openstack sfc port chain delete ${name}
1074     [Return]    ${output}
1075
1076 Reboot Nova VM
1077     [Arguments]    ${vm_name}
1078     [Documentation]    Reboot NOVA VM
1079     ${output} =    OpenStack CLI    openstack server reboot --wait ${vm_name}
1080     BuiltIn.Wait Until Keyword Succeeds    35s    10s    OpenStackOperations.Verify VM Is ACTIVE    ${vm_name}
1081
1082 Remove RSA Key From KnownHosts
1083     [Arguments]    ${vm_ip}
1084     [Documentation]    Remove RSA
1085     OpenStackOperations.Get ControlNode Connection
1086     ${output} =    DevstackUtils.Write Commands Until Prompt And Log    sudo cat /root/.ssh/known_hosts    30s
1087     ${output} =    DevstackUtils.Write Commands Until Prompt And Log    sudo ssh-keygen -f "/root/.ssh/known_hosts" -R ${vm_ip}    30s
1088     ${output} =    DevstackUtils.Write Commands Until Prompt    sudo cat "/root/.ssh/known_hosts"    30s
1089
1090 Wait For Routes To Propogate
1091     [Arguments]    ${networks}    ${subnets}
1092     [Documentation]    Check propagated routes
1093     OpenStackOperations.Get ControlNode Connection
1094     FOR    ${INDEX}    IN RANGE    0    1
1095         ${net_id} =    OpenStackOperations.Get Net Id    @{networks}[${INDEX}]
1096         ${is_ipv6} =    String.Get Regexp Matches    @{subnets}[${INDEX}]    ${IP6_REGEX}
1097         ${length} =    BuiltIn.Get Length    ${is_ipv6}
1098         ${cmd} =    BuiltIn.Set Variable If    ${length} == 0    ip route    ip -6 route
1099         ${output} =    Utils.Write Commands Until Expected Prompt    sudo ip netns exec qdhcp-${net_id} ${cmd}    ${DEFAULT_LINUX_PROMPT_STRICT}
1100         BuiltIn.Should Contain    ${output}    @{subnets}[${INDEX}]
1101     END
1102
1103 Neutron Cleanup
1104     [Arguments]    ${vms}=@{EMPTY}    ${networks}=@{EMPTY}    ${subnets}=@{EMPTY}    ${ports}=@{EMPTY}    ${sgs}=@{EMPTY}
1105     FOR    ${vm}    IN    @{vms}
1106         BuiltIn.Run Keyword And Ignore Error    Delete Vm Instance    ${vm}
1107     END
1108     FOR    ${port}    IN    @{ports}
1109         BuiltIn.Run Keyword And Ignore Error    Delete Port    ${port}
1110     END
1111     FOR    ${subnet}    IN    @{subnets}
1112         BuiltIn.Run Keyword And Ignore Error    Delete SubNet    ${subnet}
1113     END
1114     FOR    ${network}    IN    @{networks}
1115         BuiltIn.Run Keyword And Ignore Error    Delete Network    ${network}
1116     END
1117     FOR    ${sg}    IN    @{sgs}
1118         BuiltIn.Run Keyword And Ignore Error    Delete SecurityGroup    ${sg}
1119     END
1120
1121 OpenStack List All
1122     [Documentation]    Get a list of different OpenStack resources that might be in use.
1123     @{modules} =    BuiltIn.Create List    server    port    network    subnet    security group
1124     ...    security group rule    floating ip    router
1125     FOR    ${module}    IN    @{modules}
1126         ${output} =    OpenStack CLI    openstack ${module} list
1127     END
1128
1129 OpenStack CLI Get List
1130     [Arguments]    ${cmd}
1131     [Documentation]    Return a json list from the output of an OpenStack command.
1132     @{list} =    BuiltIn.Create List
1133     ${json} =    OpenStack CLI    ${cmd}
1134     @{list} =    RequestsLibrary.To Json    ${json}
1135     BuiltIn.Log    ${list}
1136     [Return]    @{list}
1137
1138 OpenStack CLI
1139     [Arguments]    ${cmd}
1140     [Documentation]    Run the given OpenStack ${cmd} and log the output.
1141     ${result} =    Process.Run Process    ${cmd}    shell=True
1142     BuiltIn.Log    ${result.stdout}
1143     BuiltIn.Log    ${result.stderr}
1144     BuiltIn.Should Be True    '${result.rc}' == '0'
1145     [Return]    ${result.stdout}
1146
1147 OpenStack CLI With No Log
1148     [Arguments]    ${cmd}
1149     [Documentation]    Run the given OpenStack ${cmd} and do not log the output.
1150     ${result} =    Process.Run Process    ${cmd}    shell=True
1151     BuiltIn.Should Be True    '${result.rc}' == '0'
1152     [Return]    ${result.stdout}
1153
1154 OpenStack Cleanup All
1155     [Documentation]    Cleanup all Openstack resources with best effort. The keyword will query for all resources
1156     ...    in use and then attempt to delete them. Errors are ignored to allow the cleanup to continue.
1157     @{fips} =    OpenStack CLI Get List    openstack floating ip list -f json
1158     FOR    ${fip}    IN    @{fips}
1159         BuiltIn.Run Keyword And Ignore Error    Delete Floating IP    ${fip['ID']}
1160     END
1161     @{vms} =    OpenStack CLI Get List    openstack server list -f json
1162     FOR    ${vm}    IN    @{vms}
1163         OpenStack CLI    openstack server show ${vm['ID']}
1164         BuiltIn.Run Keyword And Ignore Error    Delete Vm Instance    ${vm['ID']}
1165     END
1166     @{routers} =    OpenStack CLI Get List    openstack router list -f json
1167     FOR    ${router}    IN    @{routers}
1168         BuiltIn.Run Keyword And Ignore Error    Cleanup Router    ${router['ID']}
1169     END
1170     @{ports} =    OpenStack CLI Get List    openstack port list -f json
1171     FOR    ${port}    IN    @{ports}
1172         BuiltIn.Run Keyword And Ignore Error    Delete Port    ${port['ID']}
1173     END
1174     @{networks} =    OpenStack CLI Get List    openstack network list -f json
1175     FOR    ${network}    IN    @{networks}
1176         BuiltIn.Run Keyword And Ignore Error    Delete Subnet    ${network['Subnets']}
1177         BuiltIn.Run Keyword And Ignore Error    Delete Network    ${network['ID']}
1178     END
1179     @{security_groups} =    OpenStack CLI Get List    openstack security group list -f json
1180     FOR    ${security_group}    IN    @{security_groups}
1181         BuiltIn.Run Keyword If    "${security_group['Name']}" != "default"    BuiltIn.Run Keyword And Ignore Error    Delete SecurityGroup    ${security_group['ID']}
1182     END
1183     OpenStack List All
1184
1185 Cleanup Router
1186     [Arguments]    ${id}
1187     [Documentation]    Delete a router, but first remove any interfaces or gateways so that the delete will be successful.
1188     @{ports} =    OpenStack CLI Get List    openstack port list --router ${id} -f json --long
1189     FOR    ${port}    IN    @{ports}
1190         ${subnet_id} =    OpenStackOperations.Get Match    ${port['Fixed IP Addresses']}    ${REGEX_UUID}    0
1191         BuiltIn.Run Keyword If    "${port['Device Owner']}" == "network:router_gateway"    BuiltIn.Run Keyword And Ignore Error    Remove Gateway    ${id}
1192         BuiltIn.Run Keyword If    "${port['Device Owner']}" == "network:router_interface"    BuiltIn.Run Keyword And Ignore Error    Remove Interface    ${id}    ${subnet_id}
1193     END
1194     BuiltIn.Run Keyword And Ignore Error    Delete Router    ${id}
1195
1196 OpenStack Suite Setup
1197     [Documentation]    Wrapper teardown keyword that can be used in any suite running in an openstack environement
1198     SetupUtils.Setup_Utils_For_Setup_And_Teardown
1199     @{loggers} =    BuiltIn.Create List    org.apache.karaf.shell.support.ShellUtil    org.apache.sshd.server.session.ServerSessionImpl
1200     Setuputils.Setup_Logging_For_Debug_Purposes_On_List_Or_All    OFF    ${loggers}
1201     DevstackUtils.Devstack Suite Setup
1202     @{tcpdump_port_6653_conn_ids} =    OpenStackOperations.Start Packet Capture On Nodes    tcpdump_port_6653    port 6653    @{OS_ALL_IPS}
1203     BuiltIn.Set Suite Variable    @{tcpdump_port_6653_conn_ids}
1204     BuiltIn.Run Keyword If    "${PRE_CLEAN_OPENSTACK_ALL}"=="True"    OpenStack Cleanup All
1205     OpenStackOperations.Add OVS Logging On All OpenStack Nodes
1206     Validate Deployment
1207
1208 OpenStack Suite Teardown
1209     [Documentation]    Wrapper teardown keyword that can be used in any suite running in an openstack environement
1210     ...    to clean up all openstack resources. For example, all instances, networks, ports, etc will be listed and
1211     ...    and deleted. As other global cleanup tasks are needed, they can be added here and the suites will all
1212     ...    benefit automatically.
1213     # TODO: followup patch will add the list of vms to pass to Show Debugs
1214     # OpenStackOperations.Show Debugs    @{NET_1_VMS}    @{NET_2_VMS}
1215     OpenStackOperations.Get Suite Debugs
1216     OpenStack Cleanup All
1217     OpenStackOperations.Stop Packet Capture On Nodes    ${tcpdump_port_6653_conn_ids}
1218     SSHLibrary.Close All Connections
1219     FOR    ${i}    IN RANGE    ${NUM_ODL_SYSTEM}
1220         KarafKeywords.Issue Command On Karaf Console    threads --list | wc -l    ${ODL_SYSTEM_${i+1}_IP}
1221     END
1222
1223 Validate Deployment
1224     [Documentation]    Validate the deployment. Examples to validate are verifying default table
1225     ...    flows are installed and that the tunnel mesh has been built correctly.
1226     Write To Validate File    ----------------------------------------\n${SUITE_NAME}\n
1227     FOR    ${keyword}    IN    @{VALIDATION_KEYWORDS}
1228         ${status} =    Builtin.Run Keyword And Return Status    ${keyword}
1229         BuiltIn.Run Keyword If    "${status}" == "FAIL" or "${status}" == "False"    BuiltIn.Run Keywords    Write To Validate File    Failed: ${keyword}
1230         ...    AND    BuiltIn.Fail
1231         ...    ELSE    Write To Validate File    Passed: ${keyword}
1232     END
1233
1234 Write To Validate File
1235     [Arguments]    ${msg}
1236     [Documentation]    Write the given ${msg} to ${VALIDATION_FILE}. Create the file if not present.
1237     ${status} =    BuiltIn.Run Keyword And Return Status    OperatingSystem.File Should Exist    ${VALIDATION_FILE}
1238     BuiltIn.Run Keyword If    "${status}" == "False"    OperatingSystem.Create File    ${VALIDATION_FILE}
1239     OperatingSystem.Append To File    ${VALIDATION_FILE}    ${msg}\n
1240
1241 Copy DHCP Files From Control Node
1242     [Documentation]    Copy the current DHCP files to the robot vm. The keyword must be called
1243     ...    after the subnet(s) are created and before the subnet(s) are deleted.
1244     ${suite_} =    BuiltIn.Evaluate    """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
1245     ${dstdir} =    BuiltIn.Set Variable    /tmp/qdhcp/${suite_}
1246     OperatingSystem.Create Directory    ${dstdir}
1247     OpenStackOperations.Get ControlNode Connection
1248     BuiltIn.Run Keyword And Ignore Error    SSHLibrary.Get Directory    /opt/stack/data/neutron/dhcp    ${dstdir}    recursive=True
1249
1250 Is Feature Installed
1251     [Arguments]    ${features}=none
1252     FOR    ${feature}    IN    @{features}
1253         ${status}    ${output}    BuiltIn.Run Keyword And Ignore Error    BuiltIn.Should Contain    ${CONTROLLERFEATURES}    ${feature}
1254         Return From Keyword If    "${status}" == "PASS"    True
1255     END
1256     [Return]    False
1257
1258 Add OVS Logging On All OpenStack Nodes
1259     [Documentation]    Add higher levels of OVS logging to all the OpenStack nodes
1260     FOR    ${conn_id}    IN    @{OS_ALL_CONN_IDS}
1261         OVSDB.Add OVS Logging    ${conn_id}
1262     END
1263
1264 Reset OVS Logging On All OpenStack Nodes
1265     [Documentation]    Reset the OVS logging to all the OpenStack nodes
1266     FOR    ${conn_id}    IN    @{OS_ALL_CONN_IDS}
1267         OVSDB.Reset OVS Logging    ${conn_id}
1268     END
1269
1270 Start Packet Capture On Nodes
1271     [Arguments]    ${tag}    ${filter}    @{ips}
1272     [Documentation]    Wrapper keyword around the TcpDump packet capture that is catered to the Openstack setup.
1273     ...    The caller must pass the three arguments with a variable number of ips at the end,
1274     ...    but ${EMPTY} can be used for the tag and filter.
1275     ${suite_} =    BuiltIn.Evaluate    """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
1276     ${tag_} =    BuiltIn.Catenate    SEPARATOR=__    ${tag}    ${suite_}
1277     @{conn_ids} =    Tcpdump.Start Packet Capture on Nodes    tag=${tag_}    filter=${filter}    ips=${ips}
1278     [Return]    @{conn_ids}
1279
1280 Stop Packet Capture On Nodes
1281     [Arguments]    ${conn_ids}=@{EMPTY}
1282     Tcpdump.Stop Packet Capture on Nodes    ${conn_ids}
1283
1284 Server Live Migrate
1285     [Arguments]    ${vm_instance_name}
1286     [Documentation]    Keyword for live migration of VM instance
1287     ...    additional_agrs is to select particular migration(live/shared-migration/block-migration)
1288     ...    if the additional_agrs is not given default migration(shared-migration) will happen
1289     ${output} =    OpenStackOperations.OpenStack CLI    nova live-migration ${vm_instance_name}
1290
1291 Get Hypervisor Host Of Vm
1292     [Arguments]    ${vm_name}
1293     [Documentation]    Show server with neutron request.
1294     ${output} =    OpenStackOperations.OpenStack CLI    openstack server show -f value -c OS-EXT-SRV-ATTR:host ${vm_name}
1295     [Return]    ${output}
1296
1297 Check If Migration Is Complete
1298     [Arguments]    ${vm_name}
1299     [Documentation]    Show server and verify if task_state is not migrating
1300     ${output} =    OpenStackOperations.OpenStack CLI    openstack server show ${vm_name} | grep "OS-EXT-STS:task_state"
1301     BuiltIn.Should Not Contain    ${output}    migrating
1302
1303 Modify OpenStack Configuration File
1304     [Arguments]    ${conn_id}    ${file_name}    ${section}    ${key}    ${value}
1305     [Documentation]    Use crudini to modify any parameter in any Openstack configuration File
1306     SSHLibrary.Switch Connection    ${conn_id}
1307     ${output}    ${rc} =    SSHLibrary.Execute Command    sudo crudini --verbose --set --inplace ${file_name} ${section} ${key} ${value}    return_rc=True    return_stdout=True
1308     BuiltIn.Log    ${output}
1309     BuiltIn.Should Be True    '${rc}' == '0'
1310
1311 Restart DevStack Service
1312     [Arguments]    ${conn_id}    ${service_name}
1313     [Documentation]    Restart the Openstack Service
1314     SSHLibrary.Switch Connection    ${conn_id}
1315     ${output}    ${rc} =    SSHLibrary.Execute Command    sudo systemctl restart devstack@${service_name}.service    return_rc=True    return_stdout=True
1316     BuiltIn.Log    ${output}
1317     BuiltIn.Should Be True    '${rc}' == '0'
1318
1319 Get Network Segmentation Id
1320     [Arguments]    ${network_name}
1321     [Documentation]    Returns network segmentation id for the given network name.
1322     ${output} =    OpenStack CLI    openstack network show ${network_name} | grep segmentation_id | awk '{print $4}'
1323     @{list} =    String.Split String    ${output}
1324     [Return]    @{list}[0]
1325
1326 Verify Services
1327     [Documentation]    Verify if the services are operational
1328     Wait Until Keyword Succeeds    60    2    ClusterManagement.Check Status Of Services Is OPERATIONAL    @{NETVIRT_DIAG_SERVICES}
1329
1330 Verify Expected Default Tunnels
1331     [Documentation]    Verify if the default tunnels are created.
1332     ...    SFC jobs currently fail this validation because it uses of-tunnels.
1333     ...    This validation will be blocked for NEtvirt SFC jobs until support for of-tunnels
1334     ...    added to odltools.
1335     ${check_feature_list} =    BuiltIn.Create List    odl-netvirt-sfc
1336     ${is_sfc_enabled} =    OpenStackOperations.Is Feature Installed    features=${check_feature_list}
1337     BuiltIn.Return From Keyword If    ${is_sfc_enabled} == ${True}    ${True}
1338     BuiltIn.Return From Keyword If    ${OS_NODE_CNT} == ${1}    ${True}
1339     ${output} =    ODLTools.Analyze Tunnels    test_name=${SUITE_NAME}.Suite Setup
1340     BuiltIn.Should Contain    ${output}    All tunnels are up
1341
1342 Verify Expected Default Tables On Nodes
1343     [Arguments]    ${node_ips}=@{OS_ALL_IPS}
1344     [Documentation]    Verify if Default Table Entries are programmed on all Nodes
1345     ${resp} =    RequestsLibrary.Get Request    session    ${CONFIG_NODES_API}
1346     Utils.Log Content    ${resp.content}
1347     ${failed_node_list} =    BuiltIn.Create List
1348     FOR    ${node_ip}    IN    @{node_ips}
1349         ${failed_table_list} =    Verify Expected Default Tables    ${node_ip}
1350         ${failed_table_list_size} =    BuiltIn.Get Length    ${failed_table_list}
1351         BuiltIn.Run Keyword If    ${failed_table_list_size} > 0    Collections.Append To List    ${failed_node_list}    ${node_ip}
1352     END
1353     Builtin.Should Be Empty    ${failed_node_list}
1354
1355 Verify Expected Default Tables
1356     [Arguments]    ${ovs_ip}
1357     [Documentation]    Verify if Default Table Entries are programmed on specific Node
1358     ${flow_dump} =    Utils.Run Command On Remote System    ${ovs_ip}    sudo ovs-ofctl dump-flows ${INTEGRATION_BRIDGE} -OOpenFlow13
1359     BuiltIn.Log    ${flow_dump}
1360     ${failed_table_list} =    BuiltIn.Create List
1361     FOR    ${table}    IN    @{DEFAULT_FLOW_TABLES}
1362         ${rc} =    Builtin.Run Keyword And Return Status    Builtin.Should Not Match Regexp    ${flow_dump}    .*table=${table}.*priority=0
1363         BuiltIn.Run Keyword If    ${rc}    Collections.Append To List    ${failed_table_list}    ${table}
1364     END
1365     [Return]    ${failed_table_list}
1366
1367 Get Project Id
1368     [Arguments]    ${project_name}
1369     [Documentation]    Returns project ID for the given project name.
1370     ${project_id} =    OpenStack CLI    openstack project show ${project_name} -f value -c id
1371     [Return]    ${project_id}
1372
1373 Set Instance Quota For Project
1374     [Arguments]    ${num_instances}    ${project_id}
1375     [Documentation]    Set quota for the created instances using the specific project id.
1376     ${output} =    OpenStack CLI    openstack quota set --instances ${num_instances} ${project_id}
1377     [Return]    ${output}
1378
1379 Create Bgpvpn
1380     [Arguments]    ${vpnname}    ${additional_args}=${EMPTY}
1381     [Documentation]    Create Bgpvpn with neutron request.
1382     ${output} =    OpenStack CLI    openstack bgpvpn create --name ${vpnname} ${additional_args}
1383
1384 Get BgpVpn Id
1385     [Arguments]    ${vpnName}
1386     [Documentation]    Retrieve the bgpvpn id for the given bgpvpn name
1387     ${output} =    OpenStack CLI    openstack bgpvpn show ${vpnName} | grep " ID" | awk '{print $4}'
1388     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
1389     ${vpn_id} =    Collections.Get from List    ${splitted_output}    0
1390     [Return]    ${vpn_id}
1391
1392 Configure_IP_On_Sub_Interface
1393     [Arguments]    ${network_name}    ${ip}    ${vm_ip}    ${mask}    ${sub_interface_state}=${EMPTY}    ${interface}=eth0
1394     ...    ${sub_interface_number}=1
1395     [Documentation]    Keyword for configuring specified IP on specified interface and the corresponding specified sub interface
1396     OpenStackOperations.Execute Command on VM Instance    ${network_name}    ${vm_ip}    sudo ifconfig ${interface}:${sub_interface_number} ${ip} netmask ${mask} ${sub_interface_state}
1397
1398 Verify_IP_Configured_On_Sub_Interface
1399     [Arguments]    ${network_name}    ${ip}    ${vm_ip}    ${interface}=eth0    ${sub_interface_number}=1
1400     [Documentation]    Keyword for verifying specified IP on specified interface and the corresponding specified sub interface
1401     ${resp} =    OpenStackOperations.Execute Command on VM Instance    ${network_name}    ${vm_ip}    sudo ifconfig ${interface}:${sub_interface_number}
1402     BuiltIn.Should Contain    ${resp}    ${ip}