listNetworkVRs.py

#!/usr/bin/python

#      Copyright 2016, Leaseweb Technologies BV
#
#      Licensed to the Apache Software Foundation (ASF) under one
#      or more contributor license agreements.  See the NOTICE file
#      distributed with this work for additional information
#      regarding copyright ownership.  The ASF licenses this file
#      to you under the Apache License, Version 2.0 (the
#      "License"); you may not use this file except in compliance
#      with the License.  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#      Unless required by applicable law or agreed to in writing,
#      software distributed under the License is distributed on an
#      "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
#      KIND, either express or implied.  See the License for the
#      specific language governing permissions and limitations
#      under the License.

# Script to list and cycle all networks
# Nuno Tavares - n.tavares@tech.leaseweb.com

import time
import sys
import getopt
from cloudstackops import cloudstackops
import os.path
from random import choice
from prettytable import PrettyTable

# Function to handle our arguments


def handleArguments(argv):
    global DEBUG
    DEBUG = 0
    global DRYRUN
    DRYRUN = 1
    global EXTENDEDOUTPUT
    EXTENDEDOUTPUT = 0
    global domainname
    domainname = ''
    global configProfileName
    configProfileName = ''
    global command
    command = 'list'
    global opFilter
    opFilter = None
    global opFilterNot
    opFilterNot = None
    global opFilterNoRR
    opFilterNoRR = None
    global opFilterName
    opFilterName = None
    global opFilterDomain
    opFilterDomain = None
    global opFilterNetworkOffering
    opFilterNetworkOffering = None
    global plainDisplay
    plainDisplay = 0
    global opUpdateServiceOffering
    opUpdateServiceOffering = None

    # Usage message
    help = "Usage: ./" + os.path.basename(__file__) + ' [options] ' + \
        '\n  --config-profile -c <profilename>\t\tSpecify the CloudMonkey profile name to get the credentials from (or specify in ./config file)' + \
        '\n  --debug\t\t\t\t\tEnable debug mode' + \
        '\n  --extended\t\t\t\t\tEnable extended info output' + \
        '\n  --exec\t\t\t\t\tExecute for real (not needed for list* scripts), default: dry-run' + \
        '\n  --plain-display\t\t\t\tEnable plain display, no pretty tables' + \
        '\n' + \
        '\n  Actions:' + \
        '\n  --restart -r\t\t\t\t\tRestarts network w/ cleanup=True' + \
        '\n  --update -u <networkofferingid> \t\tChanges the service offering of a network' + \
        '\n' + \
        '\n  Filters:' + \
        '\n  --type <networkType> \t\t\t\tApplies filter to operation, Possible networkTypes: Isolated,Shared,VPC,VPCTier' + \
        '\n  --not-type <networkType> \t\t\tApplies reverse filter to operation, Same network types as for --type' + \
        '\n  --onlyNoRR \t\t\t\t\tSelects only non-redudant VR networks' + \
        '\n  --onlyRR \t\t\t\t\tSelects only redudant VR networks' + \
        '\n  --onlyNO <networkofferingid>\t\t\tSelects only networks with specified networkofferingid' + \
        '\n  --name -n <name> \t\t\t\tSelects only the specified asset (VPC/network)' + \
        '\n  --domain -d <name> \t\t\t\tSelects only networks from specified domain name'

    try:
        opts, args = getopt.getopt(
            argv, "hc:rn:d:u:", [
                "config-profile=", "debug", "extended", "exec", "restart", "type=", "not-type=", "onlyNoRR", "onlyRR", "onlyNO=", "name=", "plain-display", "domain=", "update="])
    except getopt.GetoptError as e:
        print "Error: " + str(e)
        print help
        sys.exit(2)

    if len(opts) == 0:
        print help
        sys.exit(2)

    for opt, arg in opts:
        if opt == '-h':
            print help
            sys.exit()
        elif opt in ["-c", "--config-profile"]:
            configProfileName = arg
        elif opt in ["--domain", "-d"]:
            opFilterDomain = arg
        elif opt in ["--debug"]:
            DEBUG = 1
        elif opt in ["--extended"]:
            EXTENDEDOUTPUT = 1
        elif opt in ["--exec"]:
            DRYRUN = 0
        elif opt in ["-r", "--restart"]:
            command = 'restartcleanup'
        elif opt in ["-u", "--update"]:
            command = 'updateserviceoffering'
            opUpdateServiceOffering = arg
        elif opt in ["--type"]:
            opFilter = arg
        elif opt in ["-n", "--name"]:
            opFilterName = arg
        elif opt in ["--not-type"]:
            opFilterNot = arg
        elif opt in ("--onlyNO"):
            print "setting onlyNO=%s" % arg
            opFilterNetworkOffering = arg
        elif opt in ["--onlyNoRR"]:
            opFilterNoRR = False
        elif opt in ["--onlyRR"]:
            opFilterNoRR = True
        elif opt in ["--plain-display"]:
            plainDisplay = 1

    # Default to cloudmonkey default config file
    if len(configProfileName) == 0:
        configProfileName = "config"

    allowed_network_types = [None, 'Isolated','Shared', 'VPC', 'VPCTier']
    if opFilter != '' and opFilter not in allowed_network_types and opFilterNot not in allowed_network_types:
        print "ERROR: Invalid filter: %s" % opFilter
        sys.exit(3)

    if DEBUG==1:
        print '[d-d] filter=%s, filterNot=%s, filterNoRR=%s, filterName=%s, filterDomain=%s' % (opFilter, opFilterNot, opFilterNoRR, opFilterName, opFilterDomain) 

# Parse arguments
if __name__ == "__main__":
    handleArguments(sys.argv[1:])

# Init our class
c = cloudstackops.CloudStackOps(DEBUG, DRYRUN)

if DEBUG == 1:
    print "# Warning: Debug mode is enabled!"

if DRYRUN == 1:
    print "# Warning: dry-run mode is enabled, not running any commands!"

# make credentials file known to our class
c.configProfileName = configProfileName

# Init the CloudStack API
c.initCloudStackAPI()

if DEBUG == 1:
    print "API address: " + c.apiurl
    print "ApiKey: " + c.apikey
    print "SecretKey: " + c.secretkey

if DEBUG == 1:
    print "opFilter=" + str(opFilter)
    print "opFilterNot=" + str(opFilterNot)
    print "opFilterNoRR=" + str(opFilterNoRR)
    print "opFilterNetworkOffering=" + str(opFilterNetworkOffering)
    print "opFilterName=" + str(opFilterName)
    print "opFilterDomain=" + str(opFilterDomain)

def getListNetworks(filter=None, filterNot=None, filterNoRR=None, assetName=None, domainName=None, filterNetworkOffering=None):

    cacheNetOffs = {}
    results = []
    if DEBUG == 1:
        print '[d] getListNetworks() - networkType = %s, rrType = %s' % (opFilter, opFilterNoRR)
        print '[d] getListNetworks() - filter=%s, filterNot=%s, filterNoRR=%s, filterName=%s, filterDomain=%s' % (filter, filterNot, filterNoRR, assetName, domainName)
        print '[d] getListNetworks() - filterNetworkOffering = %s' % (filterNetworkOffering)

    domainId = None
    if domainName:
        domainIdr = c.listDomainsExt({'name': domainName})
        if domainIdr[0]:
            domainId = domainIdr[0].id
        if DEBUG==1:
            print '[d] resolved: domainName=%s, domainId=%s' % (domainName, domainId)
    
    networkData = c.listNetworks({'name': assetName, 'domainid': domainId})
    for network in networkData:
        rr_type = False
        net_type = network.type

        if network.service:
            for netsvc in network.service:
                if netsvc.capability:
                    for cap in netsvc.capability:
                        if cap.name == 'RedundantRouter':
                            if cap.value == 'true':
                                rr_type = True
        if network.vpcid:
            net_type = 'VPCTier'

        routersData = c.getRouterData({'networkid': network.id})
        routers = []
        if routersData:
            for r in routersData:
                routers = routers + [ r.name ]

        # BEGIN:NetworkCapabilitiesFIX
        # Due to a bug in CS (at least up to 4.7.1), a network is shown as 
        # redundant while deriving from a non-redundant network offering
        # Therefore, we're safer by checking the redundancy against the service offering :(
        # - a lot more roundtrips... that's why we try to minimize them by means of cacheNetOffs
        if network.networkofferingid in cacheNetOffs.keys():
            if DEBUG==1:
                print '[d] Using from cache: cacheNetOffs[%s] ...' % (network.networkofferingid)
            rr_type = cacheNetOffs[network.networkofferingid]
        else:
            cacheNetOffs[network.networkofferingid] = False
            no = c.listNetworkOfferings(network.networkofferingid)
            for no_this in no:
                if no_this.service:
                    for svc in no_this.service:
                        if svc.name == 'SourceNat':
                            for cap in svc.capability:
                                if cap.name and cap.name == 'RedundantRouter':
                                    cacheNetOffs[no_this.id] = cap.value.lower() in ("true")
                                    rr_type = cacheNetOffs[no_this.id]
                                    if DEBUG == 1:
                                        print "[d] adding to cacheNetOffs: %s = %s" % (network.networkofferingid, cap.value)
        # END:NetworkCapabilitiesFIX
        
        if ( (filter in [None, net_type]) and (filterNot not in [net_type]) and (filterNoRR in [None, rr_type]) and (assetName in [None, network.name]) and (domainName in [None, network.domain]) and (filterNetworkOffering in [None, network.networkofferingid])):
            results = results + [{ 'id': network.id, 'type': net_type, 'name': network.name, 'domain': network.domain, 'rr_type': rr_type, 'restartrequired': network.restartrequired, 'state': network.state, 'networkofferingid': network.networkofferingid, 'vrs': ','.join(routers) }]

    vpcData = c.listVPCs({'name': assetName, 'domainid': domainId})
    for vpc in vpcData:
        rr_type = False
        if vpc.redundantvpcrouter:
            rr_type = vpc.redundantvpcrouter

        routersData = c.getRouterData({'vpcid': vpc.id})
        routers = []
        if routersData:
            for r in routersData:
                routers = routers + [ r.name ]

        if ( (filter in [None, 'VPC']) and (filterNot not in ['VPC']) and (filterNoRR in [None, rr_type]) and (assetName in [None, vpc.name]) and (domainName in [None, vpc.domain]) and (filterNetworkOffering in [None, vpc.networkofferingid]) ):
             results = results + [{ 'id': vpc.id, 'type': 'VPC', 'name': vpc.name, 'domain': vpc.domain, 'rr_type': rr_type, 'restartrequired': vpc.restartrequired, 'state': vpc.state, 'networkofferingid': vpc.networkofferingid, 'vrs': ','.join(routers) }]

    def getSortKey(item):
        return item['name'].upper()
    
    return sorted(results, key=getSortKey)


def cmdListNetworks():
    networkData = getListNetworks(opFilter, opFilterNot, opFilterNoRR, opFilterName, opFilterDomain, opFilterNetworkOffering)
    counter = 0

#    import pprint
#    pp = pprint.PrettyPrinter(indent=4)
#    pp.pprint(networkData)
    
    # Empty line
    print
    if EXTENDEDOUTPUT==1:
        t = PrettyTable(["#", "Network", "Type", "ID", "Domain", "State", "NetworkOffering", "Redundant?", "RestartReq?", "VRs"])
    else:
        t = PrettyTable(["#", "Network", "Type", "ID", "Domain", "State", "Redundant?", "RestartReq?", "VRs"])
    #t.align["VM"] = "l"
    
    if plainDisplay == 1:
        t.border = False
        t.header = False
        t.padding_width = 1

    for n in networkData:
        counter = counter + 1
        n_name = n['name']
        if plainDisplay:
            n_name = n['name'].replace(' ', '_')

        if EXTENDEDOUTPUT==1:
            t.add_row([counter, n_name, n['type'], n['id'], n['domain'], n['state'], n['networkofferingid'], n['rr_type'], n['restartrequired'], n['vrs']])
        else:
            t.add_row([counter, n_name, n['type'], n['id'], n['domain'], n['state'], n['rr_type'], n['restartrequired'], n['vrs']])

    # Display table
    print t

def cmdRestartNetworks():
    networkData = getListNetworks(opFilter, opFilterNot, opFilterNoRR, opFilterName, opFilterDomain, opFilterNetworkOffering)

    print
    import pprint
    pp = pprint.PrettyPrinter(indent=4)
#    pp.pprint(networkData)

    for n in networkData:
        print "[I] Restarting network/VPC: %s" % n['name']
        if DEBUG==1:
            print "[d] + state=%s, type=%s, rr_type=%s" % (n['state'], n['type'], n['rr_type'])
            print "[d] + id=%s" % (n['id'])
        
        if n['type'] == 'VPC':
            routersData = c.getRouterData({'vpcid': n['id']})
        else:
            routersData = c.getRouterData({'networkid': n['id']})
        if routersData:
            for r in routersData:
                #pp.pprint(r)
                print "[d]   + %s (state=%s, rr=%s)" % (r.name, r.state, r.redundantstate)

        sys.stdout.flush()
        if (n['type'] == 'VPC') and (n['state'] == 'Enabled'):
            if DRYRUN==1:
                print "[I] DRYRUN==1: Skipped restartVPC(id=%s, True)" % (n['id'])
            else:
                c.restartVPC(n['id'], True)
        elif (n['type'] in ['Isolated']) and (n['state'] == 'Implemented'):
            if DRYRUN==1:
                print "[I] DRYRUN==1: Skipped restartNetwork(id=%s, True)" % (n['id'])
            else:
                print c.restartNetwork(n['id'], True)
        elif (n['type'] in ['Shared']) and (n['state'] == 'Setup'):
            if DRYRUN==1:
                print "[I] DRYRUN==1: Skipped restartNetwork(id=%s, True)" % (n['id'])
            else:
                print c.restartNetwork(n['id'], True)
        else:
            print "[I] Skipped restartNetwork() due to unmet practical benefit"

def cmdUpdateNetworks():
    # Let's make sure the network offering exists
    newNetworkOfferingData = c.listNetworkOfferings(opUpdateServiceOffering)
    if (type(newNetworkOfferingData) != list) or (len(newNetworkOfferingData)<=0):
        print "ERROR: Probably invalid network offering = " + opUpdateServiceOffering
        sys.exit(1)
    
    newno = newNetworkOfferingData[0]
    print "networkOffering.id=" + str(newno.id) + ", forvpc=" + str(newno.forvpc)

    networkData = getListNetworks(opFilter, opFilterNot, opFilterNoRR, opFilterName, opFilterDomain, opFilterNetworkOffering)

    print
    import pprint
    pp = pprint.PrettyPrinter(indent=4)
#    pp.pprint(networkData)

    for n in networkData:
        print "[I] Updating network/VPC: %s" % n['name']
        if DEBUG==1:
            print "[d] + state=%s, type=%s, rr_type=%s" % (n['state'], n['type'], n['rr_type'])
            print "[d] + id=%s" % (n['id'])
        
        if (n['type'] == 'VPC') and newno.forvpc:
            if  DRYRUN==1:
                print "[I] DRYRUN==1: Skipped updateNetwork(id=%s, networkofferingid=%s)" % (n['id'], newno.id)
            else:
                print c.updateNetwork({'id': n['id'], 'networkofferingid': newno.id})
        elif (n['type'] in ('Isolated', 'Shared')) and (not newno.forvpc):
            if  DRYRUN==1:
                print "[I] DRYRUN==1: Skipped updateNetwork(id=%s, networkofferingid=%s)" % (n['id'], newno.id)
            else:
                print c.updateNetwork({'id': n['id'], 'networkofferingid': newno.id})
        else:
            print "[I] Skipped updateNetwork() due to unmet practical benefit"



if command == 'list':
    cmdListNetworks()
elif command == 'restartcleanup':
    cmdRestartNetworks()
elif command == 'updateserviceoffering':
    cmdUpdateNetworks()