Class: VCenterDriver::Datacenter

Inherits:
Object
  • Object
show all
Defined in:
lib/datacenter.rb

Overview

Class Datacenter

Constant Summary collapse

DPG_CREATE_TIMEOUT = 
240

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(item, vi_client = nil) ⇒ Datacenter

Returns a new instance of Datacenter.



843
844
845
846
847
848
849
850
 
# File 'lib/datacenter.rb', line 843

def initialize(item, vi_client = nil)
    check_item(item, RbVmomi::VIM::Datacenter)

    @vi_client = vi_client
    @item = item
    @net_rollback = []
    @locking = true
end

Instance Attribute Details

#item ⇒ Object

Returns the value of attribute item.



839
840
841
 
# File 'lib/datacenter.rb', line 839

def item
  @item
end

Class Method Details

.new_from_ref(ref, vi_client) ⇒ Object 



1316
1317
1318
 
# File 'lib/datacenter.rb', line 1316

def self.new_from_ref(ref, vi_client)
    new(RbVmomi::VIM::Datacenter.new(vi_client.vim, ref), vi_client)
end

Instance Method Details

#create_dpg(dvs, pg_name, vlan_id, num_ports) ⇒ Object

Create a distributed vcenter port group



1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
 
# File 'lib/datacenter.rb', line 1102

def create_dpg(dvs, pg_name, vlan_id, num_ports)
    spec = RbVmomi::VIM::DVPortgroupConfigSpec.new

    # OpenNebula use DVS static port binding with autoexpand
    if num_ports
        spec.autoExpand = true
        spec.numPorts = num_ports
    end

    # Distributed port group name
    spec.name = pg_name

    # Set VLAN information
    spec.defaultPortConfig =
        RbVmomi::VIM::VMwareDVSPortSetting.new
    spec.defaultPortConfig.vlan =
        RbVmomi::VIM::VmwareDistributedVirtualSwitchVlanIdSpec.new
    spec.defaultPortConfig.vlan.vlanId =
        vlan_id
    spec.defaultPortConfig.vlan.inherited =
        false

    # earlyBinding. A free DistributedVirtualPort will be selected and
    # assigned to a VirtualMachine when
    # the virtual machine is reconfigured
    # to connect to the portgroup.
    spec.type = 'earlyBinding'

    begin
        dvs
            .item
            .AddDVPortgroup_Task(
                :spec => [spec]
            ).wait_for_completion
    rescue StandardError => e
        raise "The Distributed port group #{pg_name} \
        could not be created. "\
              "Reason: #{e.message}"
    end

    # wait until the network is ready and we have a reference
    portgroups = dvs['portgroup'].select do |dpg|
        dpg.instance_of?(RbVmomi::VIM::DistributedVirtualPortgroup) &&
            dpg['name'] == pg_name
    end

    (0..DPG_CREATE_TIMEOUT).each do
        break unless portgroups.empty?

        portgroups = dvs['portgroup'].select do |dpg|
            dpg
                .instance_of?(
                    RbVmomi::VIM::DistributedVirtualPortgroup
                ) && dpg['name'] == pg_name
        end
        sleep 1
    end

    if portgroups.empty?
        raise 'Cannot get VCENTER_NET_REF \
        for new distributed port group'
    end

    @net_rollback << {
        :action => :delete_dpg,
         :dpg => portgroups.first,
          :name => pg_name
    }

    portgroups.first._ref
end

#create_dvs(switch_name, pnics, mtu = 1500) ⇒ Object

Create a distributed vcenter switch in a datacenter



906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
 
# File 'lib/datacenter.rb', line 906

def create_dvs(switch_name, pnics, mtu = 1500)
    # Prepare spec for DVS creation
    spec = RbVmomi::VIM::DVSCreateSpec.new
    spec.configSpec = RbVmomi::VIM::VMwareDVSConfigSpec.new
    spec.configSpec.name = switch_name

    # Specify number of uplinks port for dpg
    if pnics
        pnics = pnics.split(',')
        if !pnics.empty?
            spec.configSpec.uplinkPortPolicy =
                RbVmomi::VIM::DVSNameArrayUplinkPortPolicy.new
            spec.configSpec.uplinkPortPolicy.uplinkPortName = []
            (0..pnics.size-1).each do |index|
                spec
                    .configSpec
                    .uplinkPortPolicy
                    .uplinkPortName[index]="dvUplink#{index+1}"
            end
        end
    end

    # Set maximum MTU
    spec.configSpec.maxMtu = mtu

    # The DVS must be created in the networkFolder of the datacenter
    begin
        dvs_creation_task = @item
                            .networkFolder
                            .CreateDVS_Task(
                                :spec => spec
                            )
        dvs_creation_task.wait_for_completion

        # If task finished successfuly we rename the uplink portgroup
        dvs = nil
        if dvs_creation_task.info.state == 'success'
            dvs = dvs_creation_task.info.result
            dvs
                .config
                .uplinkPortgroup[0]
                .Rename_Task(
                    :newName => "#{switch_name}-uplink-pg"
                ).wait_for_completion
        else
            raise "The Distributed vSwitch #{switch_name} \
            could not be created. "
        end
    rescue StandardError => e
        raise e
    end

    @net_rollback << {
        :action => :delete_dvs,
        :dvs => dvs,
        :name => switch_name
    }

    VCenterDriver::DistributedVirtualSwitch.new(dvs, @vi_client)
end

#datastore_folder ⇒ Object 



852
853
854
 
# File 'lib/datacenter.rb', line 852

def datastore_folder
    DatastoreFolder.new(@item.datastoreFolder)
end

#dpg_exists(pg_name, net_folder) ⇒ Object

Check if distributed port group exists in datacenter



1052
1053
1054
1055
1056
1057
 
# File 'lib/datacenter.rb', line 1052

def dpg_exists(pg_name, net_folder)
    net_folder.items.values.select do |dpg|
        dpg.instance_of?(VCenterDriver::DistributedPortGroup) &&
            dpg['name'] == pg_name
    end.first rescue nil
end

#dvs_exists(switch_name, net_folder) ⇒ Object

Check if distributed virtual switch exists in host



889
890
891
892
893
894
 
# File 'lib/datacenter.rb', line 889

def dvs_exists(switch_name, net_folder)
    net_folder.items.values.select do |dvs|
        dvs.instance_of?(VCenterDriver::DistributedVirtualSwitch) &&
            dvs['name'] == switch_name
    end.first rescue nil
end

#host_folder ⇒ Object 



856
857
858
 
# File 'lib/datacenter.rb', line 856

def host_folder
    HostFolder.new(@item.hostFolder)
end

#lock ⇒ Object

Locking function. Similar to flock



869
870
871
872
873
874
875
876
877
 
# File 'lib/datacenter.rb', line 869

def lock
    hostlockname = @item['name'].downcase.tr(' ', '_')
    return unless @locking

    @locking_file =
        File
        .open("/tmp/vcenter-dc-#{hostlockname}-lock", 'w')
    @locking_file.flock(File::LOCK_EX)
end

#network_folder ⇒ Object 



864
865
866
 
# File 'lib/datacenter.rb', line 864

def network_folder
    NetworkFolder.new(@item.networkFolder)
end

#network_rollback ⇒ Object

Perform vcenter network rollback operations



1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
 
# File 'lib/datacenter.rb', line 1260

def network_rollback
    @net_rollback.reverse_each do |nr|
        case nr[:action]
        when :update_dpg
            begin
                nr[:dpg].ReconfigureDVPortgroup_Task(:spec => nr[:spec])
                        .wait_for_completion
            rescue StandardError => e
                raise "A rollback operation for distributed \
                port group #{nr[:name]} could not \
                be performed. Reason: #{e.message}"
            end
        when :update_dvs
            begin
                nr[:dvs].ReconfigureDvs_Task(:spec => nr[:spec])
                        .wait_for_completion
            rescue StandardError => e
                raise "A rollback operation for distributed\
                 standard switch #{nr[:name]} could \
                 not be performed. Reason: #{e.message}"
            end
        when :delete_dvs
            begin
                nr[:dvs].Destroy_Task.wait_for_completion
            rescue RbVmomi::VIM::ResourceInUse
                next # Ignore if switch in use
            rescue RbVmomi::VIM::NotFound
                next # Ignore if switch not found
            rescue StandardError => e
                raise "A rollback operation \
                for standard switch #{nr[:name]} \
                    could not be performed. Reason: #{e.message}"
            end
        when :delete_dpg
            begin
                nr[:dpg].Destroy_Task.wait_for_completion
            rescue RbVmomi::VIM::ResourceInUse
                next # Ignore if pg in use
            rescue RbVmomi::VIM::NotFound
                next # Ignore if pg not found
            rescue StandardError => e
                raise "A rollback operation for \
                standard port group #{nr[:name]} could \
                not be performed. Reason: #{e.message}"
            end
        end
    end
end

#nsx_network(nsx_id, pg_type) ⇒ Object

Check if Opaque Network exists in datacenter



1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
 
# File 'lib/datacenter.rb', line 1062

def nsx_network(nsx_id, pg_type)
    timeout = 180
    case pg_type
    when VCenterDriver::Network::NETWORK_TYPE_NSXT
        while timeout > 0
            net_folder = network_folder
            net_folder.fetch!
            net_folder.items.values.each do |net|
                if net.instance_of?(VCenterDriver::OpaqueNetwork) &&
                   net.item.summary.opaqueNetworkId == nsx_id
                    return net.item._ref
                end
            end
            sleep(1)
            timeout -= 1
        end
    # Not used right now, but maybe neccesary in the future.
    when VCenterDriver::Network::NETWORK_TYPE_NSXV
        while timeout > 0
            net_folder = network_folder
            net_folder.fetch!
            net_folder.items.values.each do |net|
                if net.instance_of?(
                    VCenterDriver::DistributedPortGroup
                ) &&
                   net.item.key == nsx_id
                    return net.item._ref
                end
            end
            sleep(1)
            timeout -= 1
        end
    else
        raise "Unknown network Port Group type: #{pg_type}"
    end
end

#pg_changes_sw?(dpg, switch_name) ⇒ Boolean

Is the distributed switch for the distributed pg different?

Returns:

  • (Boolean) 


899
900
901
 
# File 'lib/datacenter.rb', line 899

def pg_changes_sw?(dpg, switch_name)
    dpg['config.distributedVirtualSwitch.name'] != switch_name
end

#power_on_vm(vm) ⇒ Object

PowerOn VMs



1312
1313
1314
 
# File 'lib/datacenter.rb', line 1312

def power_on_vm(vm)
    @item.PowerOnMultiVM_Task({ :vm => [vm] }).wait_for_completion
end

#remove_dpg(dpg) ⇒ Object

Remove distributed port group from datacenter



1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
 
# File 'lib/datacenter.rb', line 1244

def remove_dpg(dpg)
    begin
        dpg.item.Destroy_Task.wait_for_completion
    rescue RbVmomi::VIM::ResourceInUse
        STDERR.puts "The distributed portgroup \
        #{dpg['name']} is in use so it cannot be deleted"
        nil
    rescue StandardError => e
        raise "The Distributed portgroup #{dpg['name']} \
        could not be deleted. Reason: #{e.message} "
    end
end

#remove_dvs(dvs) ⇒ Object

Remove a distributed vcenter switch in a datacenter



1041
1042
1043
1044
1045
1046
1047
 
# File 'lib/datacenter.rb', line 1041

def remove_dvs(dvs)
    begin
        dvs.item.Destroy_Task.wait_for_completion
    rescue StandardError
        # Ignore destroy task exception
    end
end

#unlock ⇒ Object

Unlock driver execution mutex



880
881
882
883
884
 
# File 'lib/datacenter.rb', line 880

def unlock
    return unless @locking

    @locking_file.close
end

#update_dpg(dpg, vlan_id, num_ports) ⇒ Object

Update a distributed vcenter port group



1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
 
# File 'lib/datacenter.rb', line 1177

def update_dpg(dpg, vlan_id, num_ports)
    spec = RbVmomi::VIM::DVPortgroupConfigSpec.new

    changed = false

    orig_spec =
        RbVmomi::VIM::DVPortgroupConfigSpec.new
    orig_spec.numPorts =
        dpg['config.numPorts']
    orig_spec.defaultPortConfig =
        RbVmomi::VIM::VMwareDVSPortSetting.new
    orig_spec.defaultPortConfig.vlan =
        RbVmomi::VIM::VmwareDistributedVirtualSwitchVlanIdSpec.new
    orig_spec.defaultPortConfig.vlan.vlanId =
        dpg['config.defaultPortConfig.vlan.vlanId']
    orig_spec.defaultPortConfig.vlan.inherited =
        false

    if num_ports && num_ports != orig_spec.numPorts
        spec.numPorts = num_ports
        changed = true
    end

    # earlyBinding. A free DistributedVirtualPort
    # will be selected and
    # assigned to a VirtualMachine when
    # the virtual machine is reconfigured
    # to connect to the portgroup.
    spec.type = 'earlyBinding'

    if vlan_id != orig_spec.defaultPortConfig.vlan.vlanId
        spec.defaultPortConfig =
            RbVmomi::VIM::VMwareDVSPortSetting.new
        spec.defaultPortConfig.vlan =
            RbVmomi::VIM::VmwareDistributedVirtualSwitchVlanIdSpec.new
        spec.defaultPortConfig.vlan.vlanId = vlan_id
        spec.defaultPortConfig.vlan.inherited = false
        changed = true
    end

    return unless changed

    spec.configVersion = dpg['config.configVersion']

    begin
        dpg
            .item
            .ReconfigureDVPortgroup_Task(
                :spec => spec
            ).wait_for_completion
    rescue StandardError => e
        raise "The Distributed port group #{dpg['name']} \
        could not be created. "\
                "Reason: #{e.message}"
    end

    @net_rollback << {
        :action => :update_dpg,
            :dpg => dpg.item,
            :name => dpg['name'],
            :spec => orig_spec
    }
end

#update_dvs(dvs, pnics, mtu) ⇒ Object

Update a distributed vcenter switch



970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
 
# File 'lib/datacenter.rb', line 970

def update_dvs(dvs, pnics, mtu)
    # Prepare spec for DVS creation
    spec = RbVmomi::VIM::VMwareDVSConfigSpec.new
    changed = false

    orig_spec = RbVmomi::VIM::VMwareDVSConfigSpec.new
    orig_spec.maxMtu = dvs['config.maxMtu']
    orig_spec.uplinkPortPolicy =
        RbVmomi::VIM::DVSNameArrayUplinkPortPolicy.new
    orig_spec.uplinkPortPolicy.uplinkPortName = []
    (0..dvs['config.uplinkPortgroup'].length-1).each do |index|
        orig_spec
            .uplinkPortPolicy
            .uplinkPortName[index]="dvUplink#{index+1}"
    end

    # Add more uplinks to default uplink
    # port group according to number of pnics
    if pnics
        pnics = pnics.split(',')
        if !pnics.empty? && dvs['config.uplinkPortgroup']
           .length != pnics.size
            spec.uplinkPortPolicy =
                RbVmomi::VIM::DVSNameArrayUplinkPortPolicy.new
            spec.uplinkPortPolicy.uplinkPortName = []
            (dvs['config.uplinkPortgroup']
            .length..num_pnics-1)
                .each do |index|
                spec
                    .uplinkPortPolicy
                    .uplinkPortName[index] =
                    "dvUplink#{index+1}"
            end
            changed = true
        end
    end

    # Set maximum MTU
    if mtu != dvs['config.maxMtu']
        spec.maxMtu = mtu
        changed = true
    end

    # The DVS must be created in the networkFolder of the datacenter
    return unless changed

    spec.configVersion = dvs['config.configVersion']

    begin
        dvs
            .item
            .ReconfigureDvs_Task(
                :spec => spec
            ).wait_for_completion
    rescue StandardError => e
        raise "The Distributed switch #{dvs['name']} could \
        not be updated. "\
                "Reason: #{e.message}"
    end

    @net_rollback << {
        :action => :update_dvs,
            :dvs => dvs.item,
            :name => dvs['name'],
            :spec => orig_spec
    }
end

#vm_folder ⇒ Object 



860
861
862
 
# File 'lib/datacenter.rb', line 860

def vm_folder
    VirtualMachineFolder.new(@item.vmFolder)
end