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