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           SSHLibrary
   5 Library           OperatingSystem
   6 Resource          DataModels.robot
   7 Resource          Utils.robot
   8 Resource          SSHKeywords.robot
   9 Resource          L2GatewayOperations.robot
  10 Resource          ../variables/Variables.robot
  11 Resource          ../variables/netvirt/Variables.robot
  12 Variables         ../variables/netvirt/Modules.py
  13
  14 *** Keywords ***
  15 Get Tenant ID From Security Group
  16     [Documentation]    Returns tenant ID by reading it from existing default security-group.
  17     ${rc}    ${output}=    Run And Return Rc And Output    openstack security group show default | grep "| tenant_id" | awk '{print $4}'
  18     Log    ${output}
  19     Should Not Be True    ${rc}
  20     [Return]    ${output}
  21
  22 Get Tenant ID From Network
  23     [Arguments]    ${network_uuid}
  24     [Documentation]    Returns tenant ID by reading it from existing network.
  25     ${resp}=    Get_From_Uri    uri=${CONFIG_API}/neutron:neutron/networks/network/${network_uuid}/    accept=${ACCEPT_EMPTY}    session=session
  26     ${tenant_id}=    Utils.Extract Value From Content    ${resp}    /network/0/tenant-id    strip
  27     [Return]    ${tenant_id}
  28
  29 Create Network
  30     [Arguments]    ${network_name}    ${additional_args}=${EMPTY}    ${verbose}=TRUE
  31     [Documentation]    Create Network with neutron request.
  32     ${rc}    ${output}=    Run And Return Rc And Output    openstack network create ${network_name} ${additional_args}
  33     Log    ${output}
  34     Should Not Be True    ${rc}
  35     [Return]    ${output}
  36
  37 Update Network
  38     [Arguments]    ${network_name}    ${additional_args}=${EMPTY}
  39     [Documentation]    Update Network with neutron request.
  40     ${cmd}=    Set Variable If    '${OPENSTACK_BRANCH}'=='stable/newton'    neutron -v net-update ${network_name} ${additional_args}    openstack network set ${network_name} ${additional_args}
  41     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
  42     Log    ${output}
  43     Should Not Be True    ${rc}
  44     [Return]    ${output}
  45
  46 Show Network
  47     [Arguments]    ${network_name}
  48     [Documentation]    Show Network with neutron request.
  49     ${rc}    ${output}=    Run And Return Rc And Output    openstack network show ${network_name}
  50     Log    ${output}
  51     Should Not Be True    ${rc}
  52     [Return]    ${output}
  53
  54 List Networks
  55     [Documentation]    List networks and return output with neutron client.
  56     ${rc}    ${output}=    Run And Return Rc And Output    openstack network list
  57     Log    ${output}
  58     Should Not Be True    ${rc}
  59     [Return]    ${output}
  60
  61 List Subnets
  62     [Documentation]    List subnets and return output with neutron client.
  63     ${rc}    ${output}=    Run And Return Rc And Output    openstack subnet list
  64     Log    ${output}
  65     Should Not Be True    ${rc}
  66     [Return]    ${output}
  67
  68 Delete Network
  69     [Arguments]    ${network_name}
  70     [Documentation]    Delete Network with neutron request.
  71     ${rc}    ${output}=    Run And Return Rc And Output    openstack network delete ${network_name}
  72     Log    ${output}
  73     Should Not Be True    ${rc}
  74
  75 Create SubNet
  76     [Arguments]    ${network_name}    ${subnet}    ${range_ip}    ${additional_args}=${EMPTY}
  77     [Documentation]    Create SubNet for the Network with neutron request.
  78     ${rc}    ${output}=    Run And Return Rc And Output    openstack subnet create --network ${network_name} --subnet-range ${range_ip} ${subnet} ${additional_args}
  79     Log    ${output}
  80     Should Not Be True    ${rc}
  81
  82 Update SubNet
  83     [Arguments]    ${subnet_name}    ${additional_args}=${EMPTY}
  84     [Documentation]    Update subnet with neutron request.
  85     ${cmd}=    Set Variable If    '${OPENSTACK_BRANCH}'=='stable/newton'    neutron -v subnet-update ${subnet_name} ${additional_args}    openstack subnet set ${subnet_name} ${additional_args}
  86     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
  87     Log    ${output}
  88     Should Not Be True    ${rc}
  89     [Return]    ${output}
  90
  91 Show SubNet
  92     [Arguments]    ${subnet_name}
  93     [Documentation]    Show subnet with neutron request.
  94     ${rc}    ${output}=    Run And Return Rc And Output    openstack subnet show ${subnet_name}
  95     Log    ${output}
  96     Should Not Be True    ${rc}
  97     [Return]    ${output}
  98
  99 Create Port
 100     [Arguments]    ${network_name}    ${port_name}    ${sg}=default    ${additional_args}=${EMPTY}    ${allowed_address_pairs}=${EMPTY}
 101     [Documentation]    Create Port with neutron request.
 102     # if allowed_address_pairs is not empty we need to create the arguments to pass to the port create command. They are
 103     # in a different format with the neutron vs openstack cli.
 104     ${address_pair_length}=    Get Length    ${allowed_address_pairs}
 105     ${allowed_pairs_argv}=    Set Variable If    '${OPENSTACK_BRANCH}'=='stable/newton' and '${address_pair_length}'=='2'    --allowed-address-pairs type=dict list=true ip_address=@{allowed_address_pairs}[0] ip_address=@{allowed_address_pairs}[1]
 106     ${allowed_pairs_argv}=    Set Variable If    '${OPENSTACK_BRANCH}'!='stable/newton' and '${address_pair_length}'=='2'    --allowed-address ip-address=@{allowed_address_pairs}[0] --allowed-address ip-address=@{allowed_address_pairs}[1]    ${allowed_pairs_argv}
 107     ${allowed_pairs_argv}=    Set Variable If    '${address_pair_length}'=='0'    ${EMPTY}    ${allowed_pairs_argv}
 108     ${cmd}=    Set Variable If    '${OPENSTACK_BRANCH}'=='stable/newton'    neutron -v port-create ${network_name} --name ${port_name} --security-group ${sg} ${additional_args} ${allowed_pairs_argv}    openstack port create --network ${network_name} ${port_name} --security-group ${sg} ${additional_args} ${allowed_pairs_argv}
 109     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
 110     Log    ${output}
 111     Should Not Be True    ${rc}
 112
 113 Update Port
 114     [Arguments]    ${port_name}    ${additional_args}=${EMPTY}
 115     [Documentation]    Update port with neutron request.
 116     ${rc}    ${output}=    Run And Return Rc And Output    openstack port set ${port_name} ${additional_args}
 117     Log    ${output}
 118     Should Not Be True    ${rc}
 119     [Return]    ${output}
 120
 121 Show Port
 122     [Arguments]    ${port_name}
 123     [Documentation]    Show port with neutron request.
 124     ${rc}    ${output}=    Run And Return Rc And Output    openstack port show ${port_name}
 125     Log    ${output}
 126     Should Not Be True    ${rc}
 127     [Return]    ${output}
 128
 129 Delete Port
 130     [Arguments]    ${port_name}
 131     [Documentation]    Delete Port with neutron request.
 132     ${rc}    ${output}=    Run And Return Rc And Output    openstack port delete ${port_name}
 133     Log    ${output}
 134     Should Not Be True    ${rc}
 135
 136 List Ports
 137     [Documentation]    List ports and return output with neutron client.
 138     ${rc}    ${output}=    Run And Return Rc And Output    openstack port list
 139     Log    ${output}
 140     Should Not Be True    ${rc}
 141     [Return]    ${output}
 142
 143 List Nova VMs
 144     [Documentation]    List VMs and return output with nova client.
 145     ${rc}    ${output}=    Run And Return Rc And Output    openstack server list
 146     Log    ${output}
 147     Should Not Be True    ${rc}
 148     [Return]    ${output}
 149
 150 Create And Associate Floating IPs
 151     [Arguments]    ${external_net}    @{vm_list}
 152     [Documentation]    Create and associate floating IPs to VMs with nova request
 153     ${ip_list}=    Create List    @{EMPTY}
 154     : FOR    ${vm}    IN    @{vm_list}
 155     \    ${rc}    ${output}=    Run And Return Rc And Output    openstack floating ip create ${external_net}
 156     \    Log    ${output}
 157     \    Should Not Be True    ${rc}
 158     \    @{ip}    Get Regexp Matches    ${output}    [0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}
 159     \    ${ip_length}    Get Length    ${ip}
 160     \    Run Keyword If    ${ip_length}>0    Append To List    ${ip_list}    @{ip}[0]
 161     \    ...    ELSE    Append To List    ${ip_list}    None
 162     \    ${rc}    ${output}=    Run And Return Rc And Output    openstack server add floating ip ${vm} @{ip}[0]
 163     \    Log    ${output}
 164     \    Should Not Be True    ${rc}
 165     [Return]    ${ip_list}
 166
 167 Verify Gateway Ips
 168     [Documentation]    Verifies the Gateway Ips with dump flow.
 169     ${output}=    Write Commands Until Prompt    sudo ovs-ofctl -O OpenFlow13 dump-flows br-int
 170     Log    ${output}
 171     : FOR    ${GatewayIpElement}    IN    @{GATEWAY_IPS}
 172     \    Should Contain    ${output}    ${GatewayIpElement}
 173
 174 Verify Dhcp Ips
 175     [Documentation]    Verifies the Dhcp Ips with dump flow.
 176     ${output}=    Write Commands Until Prompt    sudo ovs-ofctl -O OpenFlow13 dump-flows br-int
 177     Log    ${output}
 178     : FOR    ${DhcpIpElement}    IN    @{DHCP_IPS}
 179     \    Should Contain    ${output}    ${DhcpIpElement}
 180
 181 Verify No Dhcp Ips
 182     [Documentation]    Verifies the Dhcp Ips with dump flow.
 183     ${output}=    Write Commands Until Prompt    sudo ovs-ofctl -O OpenFlow13 dump-flows br-int
 184     Log    ${output}
 185     : FOR    ${DhcpIpElement}    IN    @{DHCP_IPS}
 186     \    Should Not Contain    ${output}    ${DhcpIpElement}
 187
 188 Delete SubNet
 189     [Arguments]    ${subnet}
 190     [Documentation]    Delete SubNet for the Network with neutron request.
 191     Log    ${subnet}
 192     ${rc}    ${output}=    Run And Return Rc And Output    openstack subnet delete ${subnet}
 193     Log    ${output}
 194     Should Not Be True    ${rc}
 195
 196 Verify No Gateway Ips
 197     [Documentation]    Verifies the Gateway Ips removed with dump flow.
 198     ${output}=    Write Commands Until Prompt    sudo ovs-ofctl -O OpenFlow13 dump-flows br-int
 199     Log    ${output}
 200     : FOR    ${GatewayIpElement}    IN    @{GATEWAY_IPS}
 201     \    Should Not Contain    ${output}    ${GatewayIpElement}
 202
 203 Delete Vm Instance
 204     [Arguments]    ${vm_name}
 205     [Documentation]    Delete Vm instances using instance names.
 206     ${rc}    ${output}=    Run And Return Rc And Output    openstack server delete ${vm_name}
 207     Log    ${output}
 208     Log    ${rc}
 209
 210 Get Net Id
 211     [Arguments]    ${network_name}    ${devstack_conn_id}
 212     [Documentation]    Retrieve the net id for the given network name to create specific vm instance
 213     ${rc}    ${output}=    Run And Return Rc And Output    openstack network list | grep "${network_name}" | awk '{print $2}'
 214     Log    ${output}
 215     Should Not Be True    ${rc}
 216     ${splitted_output}=    Split String    ${output}    ${EMPTY}
 217     ${net_id}=    Get from List    ${splitted_output}    0
 218     Log    ${net_id}
 219     [Return]    ${net_id}
 220
 221 Get Subnet Id
 222     [Arguments]    ${subnet_name}    ${devstack_conn_id}
 223     [Documentation]    Retrieve the subnet id for the given subnet name
 224     ${rc}    ${output}=    Run And Return Rc And Output    openstack subnet show "${subnet_name}" | grep " id " | awk '{print $4}'
 225     Log    ${output}
 226     Should Not Be True    ${rc}
 227     ${splitted_output}=    Split String    ${output}    ${EMPTY}
 228     ${subnet_id}=    Get from List    ${splitted_output}    0
 229     Log    ${subnet_id}
 230     [Return]    ${subnet_id}
 231
 232 Get Port Id
 233     [Arguments]    ${port_name}    ${devstack_conn_id}
 234     [Documentation]    Retrieve the port id for the given port name to attach specific vm instance to a particular port
 235     ${rc}    ${output}=    Run And Return Rc And Output    openstack port list | grep "${port_name}" | awk '{print $2}'
 236     Log    ${output}
 237     Should Not Be True    ${rc}
 238     ${splitted_output}=    Split String    ${output}    ${EMPTY}
 239     ${port_id}=    Get from List    ${splitted_output}    0
 240     Log    ${port_id}
 241     [Return]    ${port_id}
 242
 243 Get Router Id
 244     [Arguments]    ${router1}    ${devstack_conn_id}
 245     [Documentation]    Retrieve the router id for the given router name
 246     ${rc}    ${output}=    Run And Return Rc And Output    openstack router list -f table | grep "${router1}" | awk '{print $2}'
 247     Log    ${output}
 248     Should Not Be True    ${rc}
 249     ${splitted_output}=    Split String    ${output}    ${EMPTY}
 250     ${router_id}=    Get from List    ${splitted_output}    0
 251     Log    ${router_id}
 252     [Return]    ${router_id}
 253
 254 Create Vm Instances
 255     [Arguments]    ${net_name}    ${vm_instance_names}    ${image}=cirros-0.3.4-x86_64-uec    ${flavor}=m1.nano    ${sg}=default
 256     [Documentation]    Create X Vm Instance with the net id of the Netowrk.
 257     ${net_id}=    Get Net Id    ${net_name}    ${devstack_conn_id}
 258     : FOR    ${VmElement}    IN    @{vm_instance_names}
 259     \    ${rc}    ${output}=    Run And Return Rc And Output    openstack server create --image ${image} --flavor ${flavor} --nic net-id=${net_id} ${VmElement} --security-group ${sg}
 260     \    Should Not Be True    ${rc}
 261     \    Log    ${output}
 262
 263 Create Vm Instance With Port
 264     [Arguments]    ${port_name}    ${vm_instance_name}    ${image}=cirros-0.3.4-x86_64-uec    ${flavor}=m1.nano    ${sg}=default
 265     [Documentation]    Create One VM instance using given ${port_name} and for given ${compute_node}
 266     ${port_id}=    Get Port Id    ${port_name}    ${devstack_conn_id}
 267     ${rc}    ${output}=    Run And Return Rc And Output    openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} ${vm_instance_name} --security-groups ${sg}
 268     Log    ${output}
 269
 270 Create Vm Instance With Ports
 271     [Arguments]    ${port_name}    ${port2_name}    ${vm_instance_name}    ${image}=cirros-0.3.4-x86_64-uec    ${flavor}=m1.nano    ${sg}=default
 272     [Documentation]    Create One VM instance using given ${port_name} and for given ${compute_node}
 273     ${port_id}=    Get Port Id    ${port_name}    ${devstack_conn_id}
 274     ${port2_id}=    Get Port Id    ${port2_name}    ${devstack_conn_id}
 275     ${rc}    ${output}=    Run And Return Rc And Output    openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} --nic port-id=${port2_id} ${vm_instance_name} --security-group ${sg}
 276     Log    ${output}
 277     Should Not Be True    ${rc}
 278
 279 Create Vm Instance With Port On Compute Node
 280     [Arguments]    ${port_name}    ${vm_instance_name}    ${compute_node}    ${image}=cirros-0.3.4-x86_64-uec    ${flavor}=m1.nano    ${sg}=default
 281     [Documentation]    Create One VM instance using given ${port_name} and for given ${compute_node}
 282     ${port_id}=    Get Port Id    ${port_name}    ${devstack_conn_id}
 283     ${hostname_compute_node}=    Run Command On Remote System    ${compute_node}    hostname
 284     ${rc}    ${output}=    Run And Return Rc And Output    openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} --security-group ${sg} --availability-zone nova:${hostname_compute_node} ${vm_instance_name}
 285     Log    ${output}
 286     Should Not Be True    ${rc}
 287
 288 Verify VM Is ACTIVE
 289     [Arguments]    ${vm_name}
 290     [Documentation]    Run these commands to check whether the created vm instance is active or not.
 291     ${rc}    ${output}=    Run And Return Rc And Output    openstack server show ${vm_name} | grep OS-EXT-STS:vm_state
 292     Log    ${output}
 293     Should Not Be True    ${rc}
 294     Should Contain    ${output}    active
 295
 296 Collect VM IP Addresses
 297     [Arguments]    ${fail_on_none}    @{vm_list}
 298     [Documentation]    Using nova console-log on the provided ${vm_list} to search for the string "obtained" which
 299     ...    correlates to the instance receiving it's IP address via DHCP. Also retrieved is the ip of the nameserver
 300     ...    if available in the console-log output. The keyword will also return a list of the learned ips as it
 301     ...    finds them in the console log output, and will have "None" for Vms that no ip was found.
 302     ${ip_list}    Create List    @{EMPTY}
 303     : FOR    ${vm}    IN    @{vm_list}
 304     \    ${rc}    ${vm_ip_line}=    Run And Return Rc And Output    openstack console log show ${vm} | grep -i "obtained"
 305     \    Log    ${vm_ip_line}
 306     \    Log    ${rc}
 307     \    @{vm_ip}    Get Regexp Matches    ${vm_ip_line}    [0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}
 308     \    ${vm_ip_length}    Get Length    ${vm_ip}
 309     \    Run Keyword If    ${vm_ip_length}>0    Append To List    ${ip_list}    @{vm_ip}[0]
 310     \    ...    ELSE    Append To List    ${ip_list}    None
 311     \    ${rc}    ${dhcp_ip_line}=    Run And Return Rc And Output    openstack console log show ${vm} | grep "^nameserver"
 312     \    Log    ${dhcp_ip_line}
 313     \    Log    ${rc}
 314     \    ${dhcp_ip}    Get Regexp Matches    ${dhcp_ip_line}    [0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}
 315     \    ${dhcp_ip_length}    Get Length    ${dhcp_ip}
 316     \    Run Keyword If    ${dhcp_ip_length}<=0    Append To List    ${dhcp_ip}    None
 317     \    Log    ${dhcp_ip}
 318     \    ${vm_console_output}=    Run    openstack console log show ${vm}
 319     \    Log    ${vm_console_output}
 320     ${dhcp_length}    Get Length    ${dhcp_ip}
 321     Run Keyword If    '${fail_on_none}' == 'true'    Should Not Contain    ${ip_list}    None
 322     Run Keyword If    '${fail_on_none}' == 'true'    Should Not Contain    ${dhcp_ip}    None
 323     Should Be True    ${dhcp_length} <= 1
 324     Return From Keyword If    ${dhcp_length}==0    ${ip_list}    ${EMPTY}
 325     [Return]    ${ip_list}    ${dhcp_ip}
 326
 327 Collect VM IPv6 SLAAC Addresses
 328     [Arguments]    ${fail_on_none}    ${prefix}    @{vm_list}
 329     [Documentation]    Using nova console-log on the provided ${vm_list} to search for the string "inet6" which
 330     ...    correlates to the instance generated IPv6 address, based on the ${prefix} received from ODL (SLAAC mode).
 331     ${ip_list}    Create List    @{EMPTY}
 332     : FOR    ${vm}    IN    @{vm_list}
 333     \    Log    ${vm}
 334     \    ${rc}    ${vm_ip_line}=    Run And Return Rc And Output    nova console-log ${vm} | grep -i "inet6"
 335     \    Log    ${vm_ip_line}
 336     \    Log    ${rc}
 337     \    @{vm_ip_list}    Get Regexp Matches    ${vm_ip_line}    ${prefix}
 338     \    ${vm_ip_length}    Get Length    ${vm_ip_list}
 339     \    Run Keyword If    ${vm_ip_length}>0    Append To List    ${ip_list}    @{vm_ip_list}[0]
 340     \    ...    ELSE    Append To List    ${ip_list}    None
 341     \    Log    ${ip_list}
 342     Run Keyword If    '${fail_on_none}' == 'true'    Should Not Contain    ${ip_list}    None
 343     Log    ${ip_list}
 344     [Return]    ${ip_list}
 345
 346 View Vm Console
 347     [Arguments]    ${vm_instance_names}
 348     [Documentation]    View Console log of the created vm instances using nova show.
 349     : FOR    ${VmElement}    IN    @{vm_instance_names}
 350     \    ${rc}    ${output}=    Run And Return Rc And Output    nova show ${VmElement}
 351     \    Log    ${output}
 352     \    Should Not Be True    ${rc}
 353     \    ${rc}    ${output}=    Run And Return Rc And Output    openstack console log show ${VmElement}
 354     \    Log    ${output}
 355     \    Should Not Be True    ${rc}
 356
 357 Ping Vm From DHCP Namespace
 358     [Arguments]    ${net_name}    ${vm_ip}
 359     [Documentation]    Reach all Vm Instance with the net id of the Netowrk.
 360     Log    ${vm_ip}
 361     ${devstack_conn_id}=    Get ControlNode Connection
 362     Switch Connection    ${devstack_conn_id}
 363     ${net_id}=    Get Net Id    ${net_name}    ${devstack_conn_id}
 364     Log    ${net_id}
 365     ${output}=    Write Commands Until Prompt    sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip}    20s
 366     Log    ${output}
 367     Close Connection
 368     Should Contain    ${output}    64 bytes
 369
 370 Ping From DHCP Should Not Succeed
 371     [Arguments]    ${net_name}    ${vm_ip}
 372     [Documentation]    Should Not Reach Vm Instance with the net id of the Netowrk.
 373     Return From Keyword If    "skip_if_${SECURITY_GROUP_MODE}" in @{TEST_TAGS}
 374     Log    ${vm_ip}
 375     ${devstack_conn_id}=    Get ControlNode Connection
 376     Switch Connection    ${devstack_conn_id}
 377     ${net_id}=    Get Net Id    ${net_name}    ${devstack_conn_id}
 378     Log    ${net_id}
 379     ${output}=    Write Commands Until Prompt    sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip}    20s
 380     Close Connection
 381     Log    ${output}
 382     Should Not Contain    ${output}    64 bytes
 383
 384 Ping Vm From Control Node
 385     [Arguments]    ${vm_floating_ip}    ${additional_args}=${EMPTY}
 386     [Documentation]    Ping VM floating IP from control node
 387     Log    ${vm_floating_ip}
 388     ${devstack_conn_id}=    Get ControlNode Connection
 389     Switch Connection    ${devstack_conn_id}
 390     ${output}=    Write Commands Until Prompt    ping ${additional_args} -c 3 ${vm_floating_ip}    20s
 391     Log    ${output}
 392     Close Connection
 393     Should Contain    ${output}    64 bytes
 394
 395 Ping From Instance
 396     [Arguments]    ${dest_vm_ip}
 397     [Documentation]    Ping to the expected destination ip.
 398     ${output}=    Write Commands Until Expected Prompt    ping -c 3 ${dest_vm_ip}    ${OS_SYSTEM_PROMPT}
 399     Log    ${output}
 400     [Return]    ${output}
 401
 402 Curl Metadata Server
 403     [Documentation]    Ping to the expected destination ip.
 404     ${output}=    Write Commands Until Expected Prompt    curl -i http://169.254.169.254    ${OS_SYSTEM_PROMPT}
 405     Write Commands Until Prompt    exit
 406     Should Contain    ${output}    200
 407
 408 Close Vm Instance
 409     [Documentation]    Exit the vm instance.
 410     ${output}=    Write Commands Until Prompt    exit
 411     Log    ${output}
 412
 413 Check If Console Is VmInstance
 414     [Arguments]    ${console}=cirros
 415     [Documentation]    Check if the session has been able to login to the VM instance
 416     ${output}=    Write Commands Until Expected Prompt    id    ${OS_SYSTEM_PROMPT}
 417     Should Contain    ${output}    ${console}
 418
 419 Exit From Vm Console
 420     [Documentation]    Check if the session has been able to login to the VM instance and exit the instance
 421     ${rcode}=    Run Keyword And Return Status    Check If Console Is VmInstance    cirros
 422     Run Keyword If    ${rcode}    Write Commands Until Prompt    exit
 423     Close Connection
 424
 425 Check Ping
 426     [Arguments]    ${ip_address}    ${ttl}=64
 427     [Documentation]    Run Ping command on the IP available as argument
 428     ${ethertype}=    Get Regexp Matches    ${ip_address}    ${IP_REGEX}
 429     ${output}=    Run Keyword If    ${ethertype}    Write Commands Until Expected Prompt    ping -t ${ttl} -c 3 ${ip_address}    ${OS_SYSTEM_PROMPT}
 430     ...    ELSE    Write Commands Until Expected Prompt    ping6 -t ${ttl} -c 3 ${ip_address}    ${OS_SYSTEM_PROMPT}
 431     Should Contain    ${output}    64 bytes
 432
 433 Check No Ping
 434     [Arguments]    ${ip_address}    ${ttl}=64
 435     [Documentation]    Run Ping command to the IP given as argument, executing 3 times and expecting NOT to see "64 bytes"
 436     ${output}=    Write Commands Until Expected Prompt    ping -t ${ttl} -c 3 ${ip_address}    ${OS_SYSTEM_PROMPT}
 437     Should Not Contain    ${output}    64 bytes
 438
 439 Check Metadata Access
 440     [Documentation]    Try curl on the Metadataurl and check if it is okay
 441     ${output}=    Write Commands Until Expected Prompt    curl -i http://169.254.169.254    ${OS_SYSTEM_PROMPT}
 442     Should Contain    ${output}    200
 443
 444 Execute Command on VM Instance
 445     [Arguments]    ${net_name}    ${vm_ip}    ${cmd}    ${user}=cirros    ${password}=cubswin:)
 446     [Documentation]    Login to the vm instance using ssh in the network, executes a command inside the VM and returns the ouput.
 447     ${devstack_conn_id} =    Get ControlNode Connection
 448     Switch Connection    ${devstack_conn_id}
 449     ${net_id} =    Get Net Id    ${net_name}    ${devstack_conn_id}
 450     Log    ${vm_ip}
 451     ${output} =    Write Commands Until Expected Prompt    sudo ip netns exec qdhcp-${net_id} ssh ${user}@${vm_ip} -o ConnectTimeout=10 -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null    password:
 452     Log    ${output}
 453     ${output} =    Write Commands Until Expected Prompt    ${password}    ${OS_SYSTEM_PROMPT}
 454     Log    ${output}
 455     ${rcode} =    Run Keyword And Return Status    Check If Console Is VmInstance
 456     ${output} =    Run Keyword If    ${rcode}    Write Commands Until Expected Prompt    ${cmd}    ${OS_SYSTEM_PROMPT}
 457     [Teardown]    Exit From Vm Console
 458     [Return]    ${output}
 459
 460 Test Operations From Vm Instance
 461     [Arguments]    ${net_name}    ${src_ip}    ${dest_ips}    ${user}=cirros    ${password}=cubswin:)    ${ttl}=64
 462     ...    ${ping_should_succeed}=True    ${check_metadata}=True
 463     [Documentation]    Login to the vm instance using ssh in the network.
 464     ${devstack_conn_id}=    Get ControlNode Connection
 465     Switch Connection    ${devstack_conn_id}
 466     Log    ${src_ip}
 467     ${net_id}=    Get Net Id    ${net_name}    ${devstack_conn_id}
 468     ${output}=    Write Commands Until Expected Prompt    sudo ip netns exec qdhcp-${net_id} ssh -o ConnectTimeout=10 -o StrictHostKeyChecking=no ${user}@${src_ip} -o UserKnownHostsFile=/dev/null    password:
 469     Log    ${output}
 470     ${output}=    Write Commands Until Expected Prompt    ${password}    ${OS_SYSTEM_PROMPT}
 471     Log    ${output}
 472     ${rcode}=    Run Keyword And Return Status    Check If Console Is VmInstance
 473     Run Keyword If    ${rcode}    Write Commands Until Expected Prompt    ifconfig    ${OS_SYSTEM_PROMPT}
 474     Run Keyword If    ${rcode}    Write Commands Until Expected Prompt    route -n    ${OS_SYSTEM_PROMPT}
 475     Run Keyword If    ${rcode}    Write Commands Until Expected Prompt    route -A inet6    ${OS_SYSTEM_PROMPT}
 476     Run Keyword If    ${rcode}    Write Commands Until Expected Prompt    arp -an    ${OS_SYSTEM_PROMPT}
 477     Run Keyword If    ${rcode}    Write Commands Until Expected Prompt    ip -6 neigh    ${OS_SYSTEM_PROMPT}
 478     : FOR    ${dest_ip}    IN    @{dest_ips}
 479     \    Log    ${dest_ip}
 480     \    ${string_empty}=    Run Keyword And Return Status    Should Be Empty    ${dest_ip}
 481     \    Run Keyword If    ${string_empty}    Continue For Loop
 482     \    Run Keyword If    ${rcode} and "${ping_should_succeed}" == "True"    Check Ping    ${dest_ip}    ttl=${ttl}
 483     \    ...    ELSE    Check No Ping    ${dest_ip}    ttl=${ttl}
 484     ${ethertype}=    Get Regexp Matches    ${src_ip}    ${IP_REGEX}
 485     Run Keyword If    ${rcode} and "${check_metadata}" and ${ethertype} == "True"    Check Metadata Access
 486     [Teardown]    Exit From Vm Console
 487
 488 Test Netcat Operations From Vm Instance
 489     [Arguments]    ${net_name}    ${vm_ip}    ${dest_ip}    ${additional_args}=${EMPTY}    ${port}=12345    ${user}=cirros
 490     ...    ${password}=cubswin:)
 491     [Documentation]    Use Netcat to test TCP/UDP connections to the controller
 492     ${client_data}    Set Variable    Test Client Data
 493     ${server_data}    Set Variable    Test Server Data
 494     ${devstack_conn_id}=    Get ControlNode Connection
 495     Switch Connection    ${devstack_conn_id}
 496     Log    ${vm_ip}
 497     ${output}=    Write Commands Until Prompt    ( ( echo "${server_data}" | sudo timeout 60 nc -l ${additional_args} ${port} ) & )
 498     Log    ${output}
 499     ${output}=    Write Commands Until Prompt    sudo netstat -nlap | grep ${port}
 500     Log    ${output}
 501     ${nc_output}=    Execute Command on VM Instance    ${net_name}    ${vm_ip}    sudo echo "${client_data}" | nc -v -w 5 ${additional_args} ${dest_ip} ${port}
 502     Log    ${nc_output}
 503     ${output}=    Execute Command on VM Instance    ${net_name}    ${vm_ip}    sudo route -n
 504     Log    ${output}
 505     ${output}=    Execute Command on VM Instance    ${net_name}    ${vm_ip}    sudo arp -an
 506     Log    ${output}
 507     Should Match Regexp    ${nc_output}    ${server_data}
 508
 509 Ping Other Instances
 510     [Arguments]    ${list_of_external_dst_ips}
 511     [Documentation]    Check reachability with other network's instances.
 512     ${rcode}=    Run Keyword And Return Status    Check If Console Is VmInstance
 513     : FOR    ${dest_ip}    IN    @{list_of_external_dst_ips}
 514     \    Log    ${dest_ip}
 515     \    Check Ping    ${dest_ip}
 516
 517 Create Router
 518     [Arguments]    ${router_name}
 519     [Documentation]    Create Router and Add Interface to the subnets.
 520     ${rc}    ${output}=    Run And Return Rc And Output    openstack router create ${router_name}
 521     Should Not Be True    ${rc}
 522
 523 List Router
 524     [Documentation]    List Router and return output with neutron client.
 525     ${rc}    ${output}=    Run And Return Rc And Output    openstack router list -f value
 526     Log    ${output}
 527     Should Not Be True    ${rc}
 528     [Return]    ${output}
 529
 530 Add Router Interface
 531     [Arguments]    ${router_name}    ${interface_name}
 532     ${rc}    ${output}=    Run And Return Rc And Output    openstack router add subnet ${router_name} ${interface_name}
 533     Should Not Be True    ${rc}
 534
 535 Show Router Interface
 536     [Arguments]    ${router_name}
 537     [Documentation]    List Router interface associated with given Router and return output with neutron client.
 538     ${rc}    ${output}=    Run And Return Rc And Output    openstack port list --router ${router_name} -f value
 539     Log    ${output}
 540     Should Not Be True    ${rc}
 541     [Return]    ${output}
 542
 543 Add Router Gateway
 544     [Arguments]    ${router_name}    ${external_network_name}
 545     ${cmd}=    Set Variable If    '${OPENSTACK_BRANCH}'=='stable/newton'    neutron -v router-gateway-set ${router_name} ${external_network_name}    openstack router set ${router_name} --external-gateway ${external_network_name}
 546     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
 547     Should Not Be True    ${rc}
 548
 549 Remove Interface
 550     [Arguments]    ${router_name}    ${interface_name}
 551     [Documentation]    Remove Interface to the subnets.
 552     ${rc}    ${output}=    Run And Return Rc And Output    openstack router remove subnet ${router_name} ${interface_name}
 553     Should Not Be True    ${rc}
 554
 555 Update Router
 556     [Arguments]    ${router_name}    ${cmd}
 557     [Documentation]    Update the router with the command. Router name and command should be passed as argument.
 558     ${rc}    ${output} =    Run And Return Rc And Output    openstack router set ${router_name} ${cmd}
 559     Should Not Be True    ${rc}
 560
 561 Show Router
 562     [Arguments]    ${router_name}    ${options}
 563     [Documentation]    Show information of a given router. Router name and optional fields should be sent as arguments.
 564     ${rc}    ${output} =    Run And Return Rc And Output    openstack router show ${router_name}
 565     Log    ${output}
 566
 567 Delete Router
 568     [Arguments]    ${router_name}
 569     [Documentation]    Delete Router and Interface to the subnets.
 570     ${rc}    ${output}=    Run And Return Rc And Output    openstack router delete ${router_name}
 571     Should Not Be True    ${rc}
 572
 573 Get DumpFlows And Ovsconfig
 574     [Arguments]    ${openstack_node_ip}
 575     [Documentation]    Get the OvsConfig and Flow entries from OVS from the Openstack Node
 576     Log    ${openstack_node_ip}
 577     SSHLibrary.Open Connection    ${openstack_node_ip}    prompt=${DEFAULT_LINUX_PROMPT}
 578     SSHKeywords.Flexible SSH Login    ${OS_USER}    ${DEVSTACK_SYSTEM_PASSWORD}
 579     SSHLibrary.Set Client Configuration    timeout=${default_devstack_prompt_timeout}
 580     Write Commands Until Expected Prompt    ip -o link    ${DEFAULT_LINUX_PROMPT_STRICT}
 581     Write Commands Until Expected Prompt    ip -o addr    ${DEFAULT_LINUX_PROMPT_STRICT}
 582     Write Commands Until Expected Prompt    ip route    ${DEFAULT_LINUX_PROMPT_STRICT}
 583     Write Commands Until Expected Prompt    arp -an    ${DEFAULT_LINUX_PROMPT_STRICT}
 584     ${nslist}=    Write Commands Until Expected Prompt    ip netns list | awk '{print $1}'    ${DEFAULT_LINUX_PROMPT_STRICT}
 585     @{lines}    Split To Lines    ${nslist}
 586     : FOR    ${line}    IN    @{lines}
 587     \    Write Commands Until Expected Prompt    sudo ip netns exec ${line} ip -o link    ${DEFAULT_LINUX_PROMPT_STRICT}
 588     \    Write Commands Until Expected Prompt    sudo ip netns exec ${line} ip -o addr    ${DEFAULT_LINUX_PROMPT_STRICT}
 589     \    Write Commands Until Expected Prompt    sudo ip netns exec ${line} ip route    ${DEFAULT_LINUX_PROMPT_STRICT}
 590     Write Commands Until Expected Prompt    sudo ovs-vsctl show    ${DEFAULT_LINUX_PROMPT_STRICT}
 591     Write Commands Until Expected Prompt    sudo ovs-vsctl list Open_vSwitch    ${DEFAULT_LINUX_PROMPT_STRICT}
 592     Write Commands Until Expected Prompt    sudo ovs-ofctl show br-int -OOpenFlow13    ${DEFAULT_LINUX_PROMPT_STRICT}
 593     Write Commands Until Expected Prompt    sudo ovs-ofctl dump-flows br-int -OOpenFlow13    ${DEFAULT_LINUX_PROMPT_STRICT}
 594     Write Commands Until Expected Prompt    sudo ovs-ofctl dump-groups br-int -OOpenFlow13    ${DEFAULT_LINUX_PROMPT_STRICT}
 595     Write Commands Until Expected Prompt    sudo ovs-ofctl dump-group-stats br-int -OOpenFlow13    ${DEFAULT_LINUX_PROMPT_STRICT}
 596
 597 Get Karaf Log Type From Test Start
 598     [Arguments]    ${ip}    ${test_name}    ${type}    ${user}=${ODL_SYSTEM_USER}    ${password}=${ODL_SYSTEM_PASSWORD}    ${prompt}=${ODL_SYSTEM_PROMPT}
 599     ...    ${log_file}=${WORKSPACE}/${BUNDLEFOLDER}/data/log/karaf.log
 600     ${cmd}    Set Variable    sed '1,/ROBOT MESSAGE: Starting test ${test_name}/d' ${log_file} | grep '${type}'
 601     ${output}    Run Command On Controller    ${ip}    ${cmd}    ${user}    ${password}    ${prompt}
 602     Log    ${output}
 603
 604 Get Karaf Log Types From Test Start
 605     [Arguments]    ${ip}    ${test_name}    ${types}    ${user}=${ODL_SYSTEM_USER}    ${password}=${ODL_SYSTEM_PASSWORD}    ${prompt}=${ODL_SYSTEM_PROMPT}
 606     ...    ${log_file}=${WORKSPACE}/${BUNDLEFOLDER}/data/log/karaf.log
 607     : FOR    ${type}    IN    @{types}
 608     \    Get Karaf Log Type From Test Start    ${ip}    ${test_name}    ${type}    ${user}    ${password}
 609     \    ...    ${prompt}    ${log_file}
 610
 611 Get Karaf Log Events From Test Start
 612     [Arguments]    ${test_name}    ${user}=${ODL_SYSTEM_USER}    ${password}=${ODL_SYSTEM_PASSWORD}    ${prompt}=${ODL_SYSTEM_PROMPT}
 613     ${log_types} =    Create List    ERROR    WARN    Exception
 614     Run Keyword If    0 < ${NUM_ODL_SYSTEM}    Get Karaf Log Types From Test Start    ${ODL_SYSTEM_IP}    ${test_name}    ${log_types}
 615     Run Keyword If    1 < ${NUM_ODL_SYSTEM}    Get Karaf Log Types From Test Start    ${ODL_SYSTEM_2_IP}    ${test_name}    ${log_types}
 616     Run Keyword If    2 < ${NUM_ODL_SYSTEM}    Get Karaf Log Types From Test Start    ${ODL_SYSTEM_3_IP}    ${test_name}    ${log_types}
 617
 618 Get ControlNode Connection
 619     ${control_conn_id}=    SSHLibrary.Open Connection    ${OS_CONTROL_NODE_IP}    prompt=${DEFAULT_LINUX_PROMPT_STRICT}
 620     SSHKeywords.Flexible SSH Login    ${OS_USER}    ${DEVSTACK_SYSTEM_PASSWORD}
 621     SSHLibrary.Set Client Configuration    timeout=30s
 622     [Return]    ${control_conn_id}
 623
 624 Get OvsDebugInfo
 625     [Documentation]    Get the OvsConfig and Flow entries from all Openstack nodes
 626     Run Keyword If    0 < ${NUM_OS_SYSTEM}    Get DumpFlows And Ovsconfig    ${OS_CONTROL_NODE_IP}
 627     Run Keyword If    1 < ${NUM_OS_SYSTEM}    Get DumpFlows And Ovsconfig    ${OS_COMPUTE_1_IP}
 628     Run Keyword If    2 < ${NUM_OS_SYSTEM}    Get DumpFlows And Ovsconfig    ${OS_COMPUTE_2_IP}
 629
 630 Get Test Teardown Debugs
 631     [Arguments]    ${test_name}=${TEST_NAME}
 632     Get OvsDebugInfo
 633     Run Keyword And Ignore Error    Get Model Dump    ${HA_PROXY_IP}    ${netvirt_data_models}
 634     Get Karaf Log Events From Test Start    ${test_name}
 635
 636 Get Suite Teardown Debugs
 637     Get OvsDebugInfo
 638     Get Model Dump    ${HA_PROXY_IP}    ${netvirt_data_models}
 639
 640 Show Debugs
 641     [Arguments]    @{vm_indices}
 642     [Documentation]    Run these commands for debugging, it can list state of VM instances and ip information in control node
 643     ${devstack_conn_id}=    Get ControlNode Connection
 644     Switch Connection    ${devstack_conn_id}
 645     ${output}=    Write Commands Until Prompt    sudo ip netns list
 646     Log    ${output}
 647     Close Connection
 648     : FOR    ${index}    IN    @{vm_indices}
 649     \    ${rc}    ${output}=    Run And Return Rc And Output    nova show ${index}
 650     \    Log    ${output}
 651     \    Log    ${rc}
 652     List Nova VMs
 653     List Networks
 654     List Subnets
 655     List Ports
 656
 657 Neutron Security Group Show
 658     [Arguments]    ${SecurityGroupRuleName}
 659     [Documentation]    Displays the neutron security group configurations that belongs to a given neutron security group name
 660     ${cmd}=    Set Variable    openstack security group show ${SecurityGroupRuleName}
 661     Log    ${cmd}
 662     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
 663     Log    ${output}
 664     Should Not Be True    ${rc}
 665     [Return]    ${output}
 666
 667 Neutron Port Show
 668     [Arguments]    ${PortName}
 669     [Documentation]    Display the port configuration that belong to a given neutron port
 670     ${cmd}=    Set Variable    openstack port show ${PortName}
 671     Log    ${cmd}
 672     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
 673     Log    ${output}
 674     Should Not Be True    ${rc}
 675     [Return]    ${output}
 676
 677 Neutron Security Group Create
 678     [Arguments]    ${SecurityGroupName}    ${additional_args}=${EMPTY}
 679     [Documentation]    Create a security group with specified name ,description & protocol value according to security group template
 680     ${devstack_conn_id}=    Get ControlNode Connection
 681     Switch Connection    ${devstack_conn_id}
 682     ${cmd}=    Set Variable    openstack security group create ${SecurityGroupName} ${additional_args}
 683     Log    ${cmd}
 684     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
 685     Log    ${output}
 686     Should Not Be True    ${rc}
 687     ${sgp_id}=    Should Match Regexp    ${output}    [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
 688     Log    ${sgp_id}
 689     [Return]    ${output}    ${sgp_id}
 690
 691 Neutron Security Group Update
 692     [Arguments]    ${SecurityGroupName}    ${additional_args}=${EMPTY}
 693     [Documentation]    Updating security groups
 694     ${cmd}=    Set Variable    openstack security group set ${SecurityGroupName} ${additional_args}
 695     Log    ${cmd}
 696     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
 697     Log    ${output}
 698     Should Not Be True    ${rc}
 699     [Return]    ${output}
 700
 701 Delete SecurityGroup
 702     [Arguments]    ${sg_name}
 703     [Documentation]    Delete Security group
 704     ${rc}    ${output}=    Run And Return Rc And Output    openstack security group delete ${sg_name}
 705     Log    ${output}
 706     Should Not Be True    ${rc}
 707
 708 Neutron Security Group Rule Create
 709     [Arguments]    ${Security_group_name}    &{Kwargs}
 710     [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 catenated with mandatory args, example of usage: "Neutron Security Group Rule Create ${SGP_SSH} direction=${RULE_PARAMS[0]} ethertype=${RULE_PARAMS[1]} ..."
 711     Run Keyword If    ${Kwargs}    Log    ${Kwargs}
 712     ${description}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    description    default=${None}
 713     ${direction}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    direction    default=${None}
 714     ${ethertype}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    ethertype    default=${None}
 715     ${port_range_max}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    port_range_max    default=${None}
 716     ${port_range_min}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    port_range_min    default=${None}
 717     ${protocol}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    protocol    default=${None}
 718     ${remote_group_id}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    remote_group_id    default=${None}
 719     ${remote_ip_prefix}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    remote_ip_prefix    default=${None}
 720     ${cmd}=    Set Variable    openstack security group rule create ${Security_group_name}
 721     ${cmd}=    Run Keyword If    '${description}'!='None'    Catenate    ${cmd}    --description ${description}
 722     ...    ELSE    Catenate    ${cmd}
 723     ${cmd}=    Run Keyword If    '${direction}'!='None'    Catenate    ${cmd}    --${direction}
 724     ...    ELSE    Catenate    ${cmd}
 725     ${cmd}=    Run Keyword If    '${ethertype}'!='None'    Catenate    ${cmd}    --ethertype ${ethertype}
 726     ...    ELSE    Catenate    ${cmd}
 727     ${cmd}=    Run Keyword If    '${port_range_min}'!='None' and '${port_range_max}'!='None'    Catenate    ${cmd}    --dst-port ${port_range_min}:${port_range_max}
 728     ...    ELSE IF    '${port_range_max}'!='None'    Catenate    ${cmd}    --dst-port ${port_range_max}
 729     ...    ELSE IF    '${port_range_min}'!='None'    Catenate    ${cmd}    --dst-port ${port_range_min}
 730     ...    ELSE    Catenate    ${cmd}
 731     ${cmd}=    Run Keyword If    '${protocol}'!='None'    Catenate    ${cmd}    --protocol ${protocol}
 732     ...    ELSE    Catenate    ${cmd}
 733     ${cmd}=    Run Keyword If    '${remote_group_id}'!='None'    Catenate    ${cmd}    --remote-group ${remote_group_id}
 734     ...    ELSE    Catenate    ${cmd}
 735     ${cmd}=    Run Keyword If    '${remote_ip_prefix}'!='None'    Catenate    ${cmd}    --src-ip ${remote_ip_prefix}
 736     ...    ELSE    Catenate    ${cmd}
 737     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
 738     ${rule_id}=    Should Match Regexp    ${output}    [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
 739     Log    ${rule_id}
 740     Should Not Be True    ${rc}
 741     [Return]    ${output}    ${rule_id}
 742
 743 Neutron Security Group Rule Create Legacy Cli
 744     [Arguments]    ${Security_group_name}    &{Kwargs}
 745     [Documentation]    Creates neutron security rule with neutron request 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 catenated with mandatory args, example of usage: "Neutron Security Group Rule Create ${SGP_SSH} direction=${RULE_PARAMS[0]} ethertype=${RULE_PARAMS[1]} ..."
 746     Run Keyword If    ${Kwargs}    Log    ${Kwargs}
 747     ${description}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    description    default=${None}
 748     ${direction}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    direction    default=${None}
 749     ${ethertype}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    ethertype    default=${None}
 750     ${port_range_max}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    port_range_max    default=${None}
 751     ${port_range_min}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    port_range_min    default=${None}
 752     ${protocol}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    protocol    default=${None}
 753     ${remote_group_id}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    remote_group_id    default=${None}
 754     ${remote_ip_prefix}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    remote_ip_prefix    default=${None}
 755     ${cmd}=    Set Variable    neutron security-group-rule-create ${Security_group_name}
 756     ${cmd}=    Run Keyword If    '${description}'!='None'    Catenate    ${cmd}    --description ${description}
 757     ...    ELSE    Catenate    ${cmd}
 758     ${cmd}=    Run Keyword If    '${direction}'!='None'    Catenate    ${cmd}    --direction ${direction}
 759     ...    ELSE    Catenate    ${cmd}
 760     ${cmd}=    Run Keyword If    '${ethertype}'!='None'    Catenate    ${cmd}    --ethertype ${ethertype}
 761     ...    ELSE    Catenate    ${cmd}
 762     ${cmd}=    Run Keyword If    '${port_range_max}'!='None'    Catenate    ${cmd}    --port_range_max ${port_range_max}
 763     ...    ELSE    Catenate    ${cmd}
 764     ${cmd}=    Run Keyword If    '${port_range_min}'!='None'    Catenate    ${cmd}    --port_range_min ${port_range_min}
 765     ...    ELSE    Catenate    ${cmd}
 766     ${cmd}=    Run Keyword If    '${protocol}'!='None'    Catenate    ${cmd}    --protocol ${protocol}
 767     ...    ELSE    Catenate    ${cmd}
 768     ${cmd}=    Run Keyword If    '${remote_group_id}'!='None'    Catenate    ${cmd}    --remote_group_id ${remote_group_id}
 769     ...    ELSE    Catenate    ${cmd}
 770     ${cmd}=    Run Keyword If    '${remote_ip_prefix}'!='None'    Catenate    ${cmd}    --remote_ip_prefix ${remote_ip_prefix}
 771     ...    ELSE    Catenate    ${cmd}
 772     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
 773     ${rule_id}=    Should Match Regexp    ${output}    [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
 774     Log    ${rule_id}
 775     Should Not Be True    ${rc}
 776     [Return]    ${output}    ${rule_id}
 777
 778 Security Group Create Without Default Security Rules
 779     [Arguments]    ${sg_name}    ${additional_args}=${EMPTY}
 780     [Documentation]    Create Neutron Security Group with no default rules, using specified name and optional arguments.
 781     Neutron Security Group Create    ${sg_name}    ${additional_args}
 782     Delete All Security Group Rules    ${sg_name}
 783
 784 Delete All Security Group Rules
 785     [Arguments]    ${sg_name}
 786     [Documentation]    Delete all security rules from a specified security group
 787     ${rc}    ${sg_rules_output}=    Run And Return Rc And Output    openstack security group rule list ${sg_name} -cID -fvalue
 788     Log    ${sg_rules_output}
 789     Should Not Be True    ${rc}
 790     @{sg_rules}=    Split String    ${sg_rules_output}    \n
 791     : FOR    ${rule}    IN    @{sg_rules}
 792     \    ${rc}    ${output}=    Run And Return Rc And Output    openstack security group rule delete ${rule}
 793     \    Log    ${output}
 794     \    Should Not Be True    ${rc}
 795
 796 Create Neutron Port With Additional Params
 797     [Arguments]    ${network_name}    ${port_name}    ${additional_args}=${EMPTY}
 798     [Documentation]    Create Port With given additional parameters
 799     ${cmd}=    Set Variable    neutron -v port-create ${network_name} --name ${port_name} ${additional_args}
 800     Log    ${cmd}
 801     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
 802     Log    ${output}
 803     Should Not Be True    ${rc}
 804     ${port_id}=    Should Match Regexp    ${OUTPUT}    [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
 805     Log    ${port_id}
 806     [Return]    ${OUTPUT}    ${port_id}
 807
 808 Get Ports MacAddr
 809     [Arguments]    ${portName_list}
 810     [Documentation]    Retrieve the port MacAddr for the given list of port name and return the MAC address list.
 811     ${MacAddr-list}    Create List
 812     : FOR    ${portName}    IN    @{portName_list}
 813     \    ${macAddr}=    OpenStackOperations.Get Port Mac    ${portName}    ${devstack_conn_id}
 814     \    Append To List    ${MacAddr-list}    ${macAddr}
 815     [Return]    ${MacAddr-list}
 816
 817 Get Port Ip
 818     [Arguments]    ${port_name}
 819     [Documentation]    Keyword would return the IP of the ${port_name} received.
 820     ${rc}    ${output}=    Run And Return Rc And Output    openstack port list | grep "${port_name}" | awk -F\\' '{print $2}'
 821     Log    ${output}
 822     ${splitted_output}=    Split String    ${output}    ${EMPTY}
 823     ${port_ip}=    Get from List    ${splitted_output}    0
 824     Log    ${port_ip}
 825     Should Not Be True    ${rc}
 826     [Return]    ${port_ip}
 827
 828 Get Port Mac
 829     [Arguments]    ${port_name}    ${conn_id}=${devstack_conn_id}
 830     [Documentation]    Keyword would return the MAC ID of the ${port_name} received.
 831     ${rc}    ${output}=    Run And Return Rc And Output    openstack port show ${port_name} | grep mac_address | awk '{print $4}'
 832     Log    ${output}
 833     ${splitted_output}=    Split String    ${output}    ${EMPTY}
 834     ${port_mac}=    Get from List    ${splitted_output}    0
 835     Log    ${port_mac}
 836     Should Not Be True    ${rc}
 837     [Return]    ${port_mac}
 838
 839 Create L2Gateway
 840     [Arguments]    ${bridge_name}    ${intf_name}    ${gw_name}
 841     [Documentation]    Keyword to create an L2 Gateway ${gw_name} for bridge ${bridge_name} connected to interface ${intf_name} (Using Neutron CLI).
 842     ${rc}    ${l2gw_output}=    Run And Return Rc And Output    ${L2GW_CREATE} name=${bridge_name},interface_names=${intf_name} ${gw_name}
 843     Log    ${l2gw_output}
 844     [Return]    ${l2gw_output}
 845
 846 Create L2Gateway Connection
 847     [Arguments]    ${gw_name}    ${net_name}
 848     [Documentation]    Keyword would create a new L2 Gateway Connection for ${gw_name} to ${net_name} (Using Neutron CLI).
 849     ${rc}    ${l2gw_output}=    Run And Return Rc And Output    ${L2GW_CONN_CREATE} ${gw_name} ${net_name}
 850     Log    ${l2gw_output}
 851     Should Not Be True    ${rc}
 852     [Return]    ${l2gw_output}
 853
 854 Get All L2Gateway
 855     [Documentation]    Keyword to return all the L2 Gateways available (Using Neutron CLI).
 856     ${rc}    ${output}=    Run And Return Rc And Output    ${L2GW_GET_YAML}
 857     Should Not Be True    ${rc}
 858     [Return]    ${output}
 859
 860 Get All L2Gateway Connection
 861     [Documentation]    Keyword to return all the L2 Gateway connections available (Using Neutron CLI).
 862     ${rc}    ${output}=    Run And Return Rc And Output    ${L2GW_GET_CONN_YAML}
 863     Should Not Be True    ${rc}
 864     [Return]    ${output}
 865
 866 Get L2Gateway
 867     [Arguments]    ${gw_id}
 868     [Documentation]    Keyword to check if the ${gw_id} is available in the L2 Gateway list (Using Neutron CLI).
 869     ${rc}    ${output}=    Run And Return Rc And Output    ${L2GW_SHOW} ${gw_id}
 870     Log    ${output}
 871     Should Not Be True    ${rc}
 872     [Return]    ${output}
 873
 874 Get L2gw Id
 875     [Arguments]    ${l2gw_name}
 876     [Documentation]    Keyword to retrieve the L2 Gateway ID for the ${l2gw_name} (Using Neutron CLI).
 877     ${rc}    ${output}=    Run And Return Rc And Output    ${L2GW_GET} | grep "${l2gw_name}" | awk '{print $2}'
 878     Log    ${output}
 879     Should Not Be True    ${rc}
 880     ${splitted_output}=    Split String    ${output}    ${EMPTY}
 881     ${l2gw_id}=    Get from List    ${splitted_output}    0
 882     Log    ${l2gw_id}
 883     [Return]    ${l2gw_id}
 884
 885 Get L2gw Connection Id
 886     [Arguments]    ${l2gw_name}
 887     [Documentation]    Keyword to retrieve the L2 Gateway Connection ID for the ${l2gw_name} (Using Neutron CLI).
 888     ${l2gw_id}=    OpenStackOperations.Get L2gw Id    ${l2gw_name}
 889     ${rc}    ${output}=    Run And Return Rc And Output    ${L2GW_GET_CONN} | grep "${l2gw_id}" | awk '{print $2}'
 890     Log    ${output}
 891     Should Not Be True    ${rc}
 892     ${splitted_output}=    Split String    ${output}    ${EMPTY}
 893     ${splitted_output}=    Split String    ${output}    ${EMPTY}
 894     ${l2gw_conn_id}=    Get from List    ${splitted_output}    0
 895     Log    ${l2gw_conn_id}
 896     [Return]    ${l2gw_conn_id}
 897
 898 Neutron Port List Rest
 899     [Documentation]    Keyword to get all ports details in Neutron (Using REST).
 900     ${resp} =    RequestsLibrary.Get Request    session    ${PORT_URL}
 901     Log    ${resp.content}
 902     Should Be Equal As Strings    ${resp.status_code}    200
 903     [Return]    ${resp.content}
 904
 905 Get Neutron Port Rest
 906     [Arguments]    ${port_id}
 907     [Documentation]    Keyword to get the specific port details in Neutron (Using REST).
 908     ${resp} =    RequestsLibrary.Get Request    session    ${CONFIG_API}/${GET_PORT_URL}/${port_id}
 909     Log    ${resp.content}
 910     Should Be Equal As Strings    ${resp.status_code}    200
 911     [Return]    ${resp.content}
 912
 913 Update Port Rest
 914     [Arguments]    ${port_id}    ${json_data}
 915     [Documentation]    Keyword to update ${port_id} with json data received in ${json_data} (Using REST).
 916     Log    ${json_data}
 917     ${resp} =    RequestsLibrary.Put Request    session    ${CONFIG_API}/${GET_PORT_URL}/${port_id}    ${json_data}
 918     Log    ${resp.content}
 919     Should Be Equal As Strings    ${resp.status_code}    200
 920     [Return]    ${resp.content}
 921
 922 Create And Configure Security Group
 923     [Arguments]    ${sg-name}
 924     [Documentation]    Create Security Group with given name, and default allow rules for TCP/UDP/ICMP protocols.
 925     Neutron Security Group Create    ${sg-name}
 926     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
 927     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
 928     Neutron Security Group Rule Create    ${sg-name}    direction=ingress    protocol=icmp    remote_ip_prefix=0.0.0.0/0
 929     Neutron Security Group Rule Create    ${sg-name}    direction=egress    protocol=icmp    remote_ip_prefix=0.0.0.0/0
 930     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
 931     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
 932
 933 Add Security Group To VM
 934     [Arguments]    ${vm}    ${sg}
 935     [Documentation]    Add the security group provided to the given VM.
 936     ${rc}    ${output}=    Run And Return Rc And Output    openstack server add security group ${vm} ${sg}
 937     Log    ${output}
 938     Should Not Be True    ${rc}
 939
 940 Remove Security Group From VM
 941     [Arguments]    ${vm}    ${sg}
 942     [Documentation]    Remove the security group provided to the given VM.
 943     ${devstack_conn_id}=    Get ControlNode Connection
 944     Switch Connection    ${devstack_conn_id}
 945     ${output}=    Write Commands Until Prompt    openstack server remove security group ${vm} ${sg}
 946     Log    ${output}
 947     Close Connection
 948
 949 Create SFC Flow Classifier
 950     [Arguments]    ${name}    ${src_ip}    ${dest_ip}    ${protocol}    ${dest_port}    ${neutron_src_port}
 951     [Documentation]    Create a flow classifier for SFC
 952     ${cmd}=    Set Variable    neutron flow-classifier-create --ethertype IPv4 --source-ip-prefix ${src_ip}/32 --destination-ip-prefix ${dest_ip}/32 --protocol ${protocol} --destination-port ${dest_port}:${dest_port} --logical-source-port ${neutron_src_port} ${name}
 953     Log    ${cmd}
 954     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
 955     Log    ${output}
 956     Should Not Be True    ${rc}
 957     Should Contain    ${output}    Created a new flow_classifier
 958     [Return]    ${output}
 959
 960 Delete SFC Flow Classifier
 961     [Arguments]    ${name}
 962     [Documentation]    Delete a SFC flow classifier
 963     ${devstack_conn_id}=    Get ControlNode Connection
 964     Switch Connection    ${devstack_conn_id}
 965     ${cmd}=    Set Variable    neutron flow-classifier-delete ${name}
 966     Log    ${cmd}
 967     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
 968     Log    ${output}
 969     Should Not Be True    ${rc}
 970     Should Contain    ${output}    Deleted flow_classifier
 971     [Return]    ${output}
 972
 973 Create SFC Port Pair
 974     [Arguments]    ${name}    ${port_in}    ${port_out}
 975     [Documentation]    Creates a neutron port pair for SFC
 976     ${devstack_conn_id}=    Get ControlNode Connection
 977     Switch Connection    ${devstack_conn_id}
 978     ${cmd}=    Set Variable    neutron port-pair-create --ingress=${port_in} --egress=${port_out} ${name}
 979     Log    ${cmd}
 980     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
 981     Log    ${output}
 982     Should Not Be True    ${rc}
 983     Should Contain    ${output}    Created a new port_pair
 984     [Return]    ${output}
 985
 986 Delete SFC Port Pair
 987     [Arguments]    ${name}
 988     [Documentation]    Delete a SFC port pair
 989     ${cmd}=    Set Variable    neutron port-pair-delete ${name}
 990     Log    ${cmd}
 991     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
 992     Log    ${output}
 993     Should Not Be True    ${rc}
 994     Should Contain    ${output}    Deleted port_pair
 995     [Return]    ${output}
 996
 997 Create SFC Port Pair Group
 998     [Arguments]    ${name}    ${port_pair}
 999     [Documentation]    Creates a port pair group with a single port pair for SFC
1000     ${cmd}=    Set Variable    neutron port-pair-group-create --port-pair ${port_pair} ${name}
1001     Log    ${cmd}
1002     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
1003     Log    ${output}
1004     Should Not Be True    ${rc}
1005     Should Contain    ${output}    Created a new port_pair_group
1006     [Return]    ${output}
1007
1008 Create SFC Port Pair Group With Two Pairs
1009     [Arguments]    ${name}    ${port_pair1}    ${port_pair2}
1010     [Documentation]    Creates a port pair group with two port pairs for SFC
1011     ${cmd}=    Set Variable    neutron port-pair-group-create --port-pair ${port_pair1} --port-pair ${port_pair2} ${name}
1012     Log    ${cmd}
1013     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
1014     Log    ${output}
1015     Should Not Be True    ${rc}
1016     Should Contain    ${output}    Created a new port_pair_group
1017     [Return]    ${output}
1018
1019 Delete SFC Port Pair Group
1020     [Arguments]    ${name}
1021     [Documentation]    Delete a SFC port pair group
1022     ${devstack_conn_id}=    Get ControlNode Connection
1023     ${cmd}=    Set Variable    neutron port-pair-group-delete ${name}
1024     Log    ${cmd}
1025     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
1026     Log    ${output}
1027     Should Not Be True    ${rc}
1028     Should Contain    ${output}    Deleted port_pair_group
1029     [Return]    ${output}
1030
1031 Create SFC Port Chain
1032     [Arguments]    ${name}    ${pg1}    ${pg2}    ${fc}
1033     [Documentation]    Creates a port pair chain with two port groups and a singel classifier.
1034     ${cmd}=    Set Variable    neutron port-chain-create --port-pair-group ${pg1} --port-pair-group ${pg2} --flow-classifier ${fc} ${name}
1035     Log    ${cmd}
1036     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
1037     Log    ${output}
1038     Should Not Be True    ${rc}
1039     Should Contain    ${output}    Created a new port_chain
1040     [Return]    ${output}
1041
1042 Delete SFC Port Chain
1043     [Arguments]    ${name}
1044     [Documentation]    Delete a SFC port chain
1045     ${cmd}=    Set Variable    neutron port-chain-delete ${name}
1046     Log    ${cmd}
1047     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
1048     Log    ${output}
1049     Should Not Be True    ${rc}
1050     Should Contain    ${output}    Deleted port_chain
1051     [Return]    ${output}
1052
1053 Reboot Nova VM
1054     [Arguments]    ${vm_name}
1055     [Documentation]    Reboot NOVA VM
1056     ${rc}    ${output}=    Run And Return Rc And Output    openstack server reboot --wait ${vm_name}
1057     Log    ${output}
1058     Should Not Be True    ${rc}
1059     Wait Until Keyword Succeeds    35s    10s    Verify VM Is ACTIVE    ${vm_name}
1060
1061 Remove RSA Key From KnowHosts
1062     [Arguments]    ${vm_ip}
1063     [Documentation]    Remove RSA
1064     ${devstack_conn_id}=    Get ControlNode Connection
1065     Switch Connection    ${devstack_conn_id}
1066     ${output}=    Write Commands Until Prompt    sudo cat /root/.ssh/known_hosts    30s
1067     Log    ${output}
1068     ${output}=    Write Commands Until Prompt    sudo ssh-keygen -f "/root/.ssh/known_hosts" -R ${vm_ip}    30s
1069     Log    ${output}
1070     ${output}=    Write Commands Until Prompt    sudo cat "/root/.ssh/known_hosts"    30s
1071
1072 Wait For Routes To Propogate
1073     [Arguments]    ${networks}    ${subnets}
1074     [Documentation]    Check propagated routes
1075     ${devstack_conn_id} =    Get ControlNode Connection
1076     Switch Connection    ${devstack_conn_id}
1077     : FOR    ${INDEX}    IN RANGE    0    1
1078     \    ${net_id}=    Get Net Id    @{networks}[${INDEX}]    ${devstack_conn_id}
1079     \    ${is_ipv6}=    Get Regexp Matches    @{subnets}[${INDEX}]    ${IP6_REGEX}
1080     \    ${length}=    Get Length    ${is_ipv6}
1081     \    ${cmd}=    Set Variable If    ${length} == 0    ip route    ip -6 route
1082     \    ${output}=    Write Commands Until Expected Prompt    sudo ip netns exec qdhcp-${net_id} ${cmd}    ]>
1083     \    Should Contain    ${output}    @{subnets}[${INDEX}]