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