I would like to know how to change the VIFs MAC addresses using XenServer Powershell.

I've tried to use the following:

$vm_ref=Get-XenVM -Name $VMname | Select-Object -ExpandProperty opaque_ref
New-XenVIF -VM $vm_ref -Network $NETADP -MAC “XX:XX:XX:XX:XX:XX” -Device 0

But it didn't work.

Any ideas.

Thanks!

I would like to change the boot order and the CPU usage alart on 400+ machines.

I'm here, that this should work, but it does not work. What is the command what is actually working?

==================================

$HVMBootParams = @{
    "firmware," = "uefi"
    "order," = "n"
}

set-xenvm -name "%VMNAME%" -HVMBootParams $HVMBootParams

==================================

I already tried so many different combinations, but so far nothing is working.

Could anyone tell me how to run this?

thank you

I'm trying to extend to extend a disk of a VM using the Hypervisor 8.2 powershell SDK. I can't seem to find a way.

I have set up a connection and read the VM I want to edit the disk of.

$VMs = get-xenvm  | where {$_.name_label.StartsWith("VMName")}

foreach($VM in $VMs){

    $VBDrefs = $VM.VBDs
     
    foreach($VBDref in $VBDrefs){
        $VBD = Get-XenVBD -Ref $VBDref
        $VDI = Get-XenVDI -Ref $VBD.VDI
        
        if($VDI.name_label -eq $VM.name_label + " 0"){ 
           
           $VirtualSize = ($GB * 120)
           $VirtualSize

           Set-XenVDI -VDI $VDI .... --> there is no option to set the new size of the disk here
 
           
        }

    }

}

is there a way in Powershell SDK to find VMs belonging to a particular pool member? (the affinity to a homeserver)

#this returns all VMs from the whole pool:

$vms = get-xenvm | Where-Object {$_.is_a_template -ne "False" -and $_.is_control_domain -ne "False"}

How do I return the name of the xenserver pool member the VM actually belongs to... or just filter the list by a pool member name? 

Any help is very much appreciated.

Stefan

remove-vdi deletes it ... how to just remove it ?  

using Citrix hypervisor 8.2

I'm using the powershell cmdlet from citrix.

The command I want to use is:

$Xenserver = POOLMASTER
Connect-XenServer -url $("http://"+ $Xenserver) -Creds $creds -SetDefaultSession
$pool = Get-XenPool
Invoke-XenPool -pool $pool -XenAction DesignateNewMaster

My understanding is that there is another parameter missing that sets the new pool master, but there is no other useful parameter.

Has anyone done this before and can help here?

No documentation script is ever 100% complete, but with the great help from the XenServer team and the excellent work and coding skills of John Billekens, what I thought would take over a year we accomplished in two months.

There is a LOT of data in the V1 output, but there is more to come as John figures out how to add the missing pieces and parts.

Please give the script a try and let us know what you think.

https://www.carlwebster.com/downloads/download-info/citrix-xenserver/

        Invoke-XenVM -VM $vm -XenAction MigrateSend -Live $true -Dest $dest -VifMap $vifmap -VdiMap $vdimap -Options @null -VgpuMap @null -SessionOpaqueRef $session1.opaque_ref -verbose -Async -PassThru 

Whenever the migration is complete, the VM is rebooted with unexpected error 

If Use XenCenter migration going  without reboot

I'm trying to figure out how to move a VM from one host to another with local storage using powershell.

It looks like I need to use invoke-xenvm -xenaction migratesend -name VMNAME -dest @{}

The -dest parameter is what I am unable to figure out at this moment. What items are required in this hashtable and how does the formatting look like. 

I am assuming that the destination HOST and SR are required but I am unable to figure it out.

Anyone that can help me out on this?

Best regards!

Currently all our Citrix Infrastructure and VDA servers run on VMware Hypervisor Technology. My company wants to look at Citrix Hypervisor in an attempt to save money.

We have built a POC and now wants to create a PowerShell script so that we can provision new Citrix VDA Images using Microsoft MDT.  (I have done this previously for VMware)

Where can I find decent PowerShell cmdlet documentation?  The Get-Help does not tell you much and the other links provided by the existing links are not really as useful as I hoped.

Or should I just use the examples, but then, I have questions and it will be nice to understand some of the details.

Thank you in advance.

Martin 

Went through the forum, and did not stumble upon any detail which will reveal how to be succesfull with creating a VM using the XenServerPSModule where the Boot Options for the VM is UEFI Boot.

There are no problems creating such VM's with GUI, but I'm looking for the way to get the same result with automated way...

The UEFI VM's which are created with GUI works.

Stumbled upon those two repos, which are very helpful to get some understanding about the API itself:

https://github.com/xapi-project/xen-api-sdk/blob/master/powershell/autogen/samples/AutomatedTestCore.ps1

https://github.com/ZachThurmond/Automated-XenServer-Labs/blob/master/AXL.ps1

but both of them uses the BIOS way...

If someone can assist me I would be a great help !

$ObjSourceTemplate = Get-XenVM -Name 'Windows 10 (64-bit)'

$VMName = 'w10TestUEFI'
$VMRAM = 4*1GB
$VMCPU = 4

New-XenVM -NameLabel $VMName `
          -MemoryTarget $VMRAM `
          -MemoryStaticMax $VMRAM `
          -MemoryDynamicMax $VMRAM `
          -MemoryDynamicMin $VMRAM `
          -MemoryStaticMin $VMRAM `
          -VCPUsMax $VMCPU `
          -VCPUsAtStartup $VMCPU `
          -HVMBootPolicy "BIOS order" `
          -HVMBootParams @{ order = "dc" } `
          -HVMShadowMultiplier 1 `
          -UserVersion 1 `
          -ActionsAfterReboot restart `
          -ActionsAfterCrash restart `
          -ReferenceLabel $ObjSourceTemplate.reference_label `
          -HardwarePlatformVersion 2 `
          -Platform @{ "cores-per-socket" = "$VMCPU"; hpet = "true"; pae = "true"; vga = "std"; nx = "true"; viridian_time_ref_count = "true"; apic = "true"; viridian_reference_tsc = "true"; viridian = "true"; acpi = "1" } `
          -OtherConfig @{ base_template_name = $ObjSourceTemplate.reference_label }

looks like that within the console it can be achieved this way:
xe vm-list name-label=test
xe vm-param-set uuid=[UUID] HVM-boot-params:firmware=uefi
xe vm-param-set uuid=[UUID] platform:secureboot=false

but how to achieve the same with PS from the SD

I'm working on a powershell script that required to be able to unmount or mount some ISO in a particular VM.

No prob for the "unmounting" part with invoke-xenvbd -XenAction Eject but i'm not able to mount an ISO with the same command but with the XenAction Insert.

Here is my code sample :

$Master = Get-XenVM -Name $($XD_Master.Xen_MasterName)

$ISO_library = get-XenSR | Where-Object {($_.type -eq 'iso') -and $_.name_label -notmatch 'XenServer Tools'}

$CD = ForEach ($ISO in $ISO_Library.VDIs) {Get-XenVDI -Ref $ISO.opaque_ref | Where-Object {$_.name_label -eq 'FinalisationVDI.iso'}}

$VBD = $Master.VBDs | Get-XenVBD | where {($_.Type -eq 'CD')}

I try this command to mount the ISO but it fails...

Invoke-XenVBD -Uuid $VBD.uuid -XenAction Insert $CD.uuid

Any help please ?

The command host.get_cpu_info returns the following response:
{
    "result": {
        "cpu_count": "32",
        "socket_count": "2",
        "vendor": "GenuineIntel",
        "speed": "2000.018",
        "modelname": "Intel(R) Xeon(R) CPU E5-2650 0 @ 2.00GHz",
        "family": "6",
        "model": "45",
        "stepping": "7",
        "flags": "fpu de tsc msr pae mce cx8 apic sep mca cmov pat clflush acpi mmx fxsr sse sse2 ht syscall nx lm constant_tsc arch_perfmon rep_good nopl nonstop_tsc eagerfpu pni pclmulqdq monitor est ssse3 cx16 sse4_1 sse4_2 popcnt aes xsave avx hypervisor lahf_lm ida arat epb pln pts dtherm xsaveopt",
        "features": "1fbee3ff-bfebfbff-00000001-2c100800",
        "features_pv": "17c9cbf5-96b82203-2191cbf5-00000003-00000001-00000000-00000000-00000000-00001000-8c000000-00000000-00000000-00000000-00000000",
        "features_hvm": "17cbfbff-97ba2223-2d93fbff-00000003-00000001-00000000-00000000-00000000-00001000-9c000000-00000000-00000000-00000000-00000000"
    },
    "error": null,
    "id": 0
}
But our host has 2 sockets with 8 cores per socket and 2 threads per core, so we get quantity of logical processor cores in "cpu_count" field. 

The command host.get_cpu_configuration returns empty JSON:
{"result": {}, "error": null, "id": 0}

We would like to know, if there is a possibility to get quantity of physical processor cores through API? Can we force host.get_cpu_configuration to send us information about threads per core? Can we execute shell command (xl info/lscpu) and get output without connecting via SSH?
Version of our XenServer is XenServer 7.1 CU1 (LTSR).

Thanks.

I used the com.xensource.xenapi.HostCpu  which is from Citrix XenServer Management API (xenserver-6.0.0.jar) to get XenServer 7.1Cu2 env's CPU related information such as the vendor of the physical CPU(HostCPU.vendor), the speed of the physical CPU(HostCPU.speed) , the model name of the physical CPU(HostCPU.modelname) and also including the current CPU utilisation(HostCPU.utilisation). Most attributes can get the correct values in the following JAVA code, but for CPU utilisation, it's always null.

And I also find many attributes related to memory used/total size , net work in/out throughput etc. could not get the correct values. 

A piece of my JAVA code:

-----------------------------------------------------

……

import com.xensource.xenapi.HostCpu;

……

public IAttributeGroupRecord mapRecord(HostCpu.Record record, Connection connection) throws Types.XenAPIException, XmlRpcException {

  ……

   attributeGroupRecord.add(str(record.model));

   attributeGroupRecord.add(str(record.modelname));

   attributeGroupRecord.add(str(record.speed));

   attributeGroupRecord.add(str(record.stepping));

   attributeGroupRecord.add(str(MessageFormat.format("{0,number,###.##}", record.utilisation), (record.utilisation != null) ));

   attributeGroupRecord.add(str(record.vendor));

   ……

   return attributeGroupRecord;

 }

---------------------------------------------------

My env information are:

XenServer version : 7.1 Cu2

XenServer JAVA SDK : xenserver-6.0.0-1.jar along with xmlrpc-client-3.1.3.jar and xmlrpc-common-3.1.3.jar

Thanks

What is the equivalent method on Citirx hypervisor for this operation?

https://kb.vmware.com/s/article/2108294?lang=en_us
How to download and install vCenter Server root certificates to avoid Web Browser certificate warnings (2108294)

xe host-get-server-certificate and host-server-certificate-install deal with getting and changing dom0 Web Server certificates.
Instead, I want self-signed default Citirx hypervisor certificate intact and make XenAPI clients accept the certificate.
For this, I need to import the CA certificate which generated the server certificate onto clients.
 

Where on Citrix dom0 filesystem CA certificate is located and how to extract and feed one onto XenAPI clients?

Thanks in advance,

Motohiro Kanda

I just want to leave this script here that maybe help others. Recently we have to retrieve all the NIC MAC Address from all our guest VM and their guest OS IP. To solve this tedious task I write this simple code that could evolve in something more robust if someone tweak the code.

As is the code retrieve the following from the VM:

1. VM UUID
2. VM Name
3. VM Description
4. # of CPU
5. Memory in Bytes
6. VM Power State
7. Is Template
8. NIC ID (The number of the NIC device)
9. Network Name (Attached to the NIC)
10. NIC MAC Address
11. NIC VLAN (From the Network Attached)
12. NIC IP (From the Guest OS)

I run this code on multiple XenServer 6.5 & 6.0 using the XenServer 6.5 SDK without issues. The only thing that I notice is that on XS6.0 the VLAN data can not be read. Also the XenTools must be installed to retrieve the OS IP address. 

Any suggestions would be appreciated. 

-----------Script Start------------------

Import-Module XenServerPSModule
Connect-XenServer -Url https://10.20.10.xx -UserName serveruser -Password serverpassword
$vms = get-xenvm | Where-Object {$_.is_a_template -ne "False" -and $_.is_control_domain -ne "False"} #get all vms

function New-XenVMInfo
{
New-Object PSObject -Property @{
Name = ''
UUID = ''
CPUCount = ''
Description = ''
IsTemplate = ''
MemoryStaticMax =''
PowerState = ''
NICID = ''
NICNetworkName = ''
NICMAC = ''
NICVLAN = ''
NICIP = ''
}

}

$xenVMs = @()


foreach ($vm in $vms){
$gm = Get-XenVMProperty -VM $vm -XenProperty GuestMetrics
if ($vm.VIFs.Count -gt 1)
{
for ($i=0; $i -lt $vm.VIFs.Count;$i++)
{
$xenVM = New-XenVMInfo
$xenVM.Name = $vm.name_label
$xenVM.PowerState = $vm.power_state
$xenVM.UUID = $vm.uuid
$xenVM.Description = $vm.name_description
$xenVM.IsTemplate = $vm.is_a_template
$xenVM.MemoryStaticMax = $vm.memory_static_max
$xenVM.CPUCount = $vm.vcpus_max
$vif = Get-XenVIF -Ref $vm.VIFs[$i]
$net = Get-XenNetwork -Ref $vif.network
$xenVM.NICNetworkName = $net.name_label
$pif = Get-XenPIF -Ref $net.PIFs[0]
$xenVM.NICVLAN = $pif.VLAN
$xenVM.NICMAC = $vif.MAC
$xenVM.NICID = $vif.device
$xenVM.NICIP = ($gm.networks)[ $vif.device + "/ip"]
$xenVMs += $xenVM
}
}
elseif ($vm.VIFs.Count -eq 1)
{

$xenVM = New-XenVMInfo
$xenVM.Name = $vm.name_label
$xenVM.PowerState = $vm.power_state
$xenVM.UUID = $vm.uuid
$xenVM.Description = $vm.name_description
$xenVM.IsTemplate = $vm.is_a_template
$xenVM.MemoryStaticMax = $vm.memory_static_max
$xenVM.CPUCount = $vm.vcpus_max
$vif = Get-XenVIF -Ref $vm.VIFs[0]
$net = Get-XenNetwork -Ref $vif.network
$xenVM.NICNetworkName = $net.name_label
$pif = Get-XenPIF -Ref $net.PIFs[0]
$xenVM.NICVLAN = $pif.VLAN
$xenVM.NICMAC = $vif.MAC
$xenVM.NICID = $vif.device
$xenVM.NICIP = ($gm.networks)[ $vif.device + "/ip"]
$xenVMs += $xenVM

}
else
{
$xenVM = New-XenVMInfo
$xenVM.Name = $vm.name_label
$xenVM.PowerState = $vm.power_state
$xenVM.UUID = $vm.uuid
$xenVM.Description = $vm.name_description
$xenVM.IsTemplate = $vm.is_a_template
$xenVM.MemoryStaticMax = $vm.memory_static_max
$xenVM.CPUCount = $vm.vcpus_max
$xenVM.NICID = 'No NIC Attached'
$xenVM.NICNetworkName = 'No NIC Attached'
$xenVM.NICVLAN = 'No NIC Attached'
$xenVM.NICMAC = 'No NIC Attached'
$xenVM.NICIP = 'No IP Available'
$xenVMs += $xenVM
}
}

$xenVMs | Export-Csv -Path c:\NetworkInfo.csv

Disconnect-XenServer

We want following hardware information on servers running Citrix Hypervisor.
Are these available via xe or Xen API? Vmware vCenter provides these via SDK API as well as web browser GUI.
Ssh connections are sometimes prohibited on production environment. So, we prefer xmlrpc/json API.
We know some CPU and memory information is available via host-cpu-info and host-param-list but not enough.

1 Server model name and serial number

example:
# dmidecode -t system
Handle 0x008D, DMI type 1, 27 bytes
System Information
        Manufacturer: HITACHI
        Product Name: HA8000V/DL360 Gen10
        Serial Number: SGH002V38J

Customers want this in order to locate physical machines running there guest VMs.

2 Server NIC model, harddisk model, storage controller model and PCI locations.

example:
# lspci
02:00.0 Ethernet controller: Broadcom Inc. and subsidiaries NetXtreme BCM5719 Gigabit Ethernet PCIe (rev 01)
5c:00.0 Serial Attached SCSI controller: Adaptec Smart Storage PQI 12G SAS/PCIe 3 (rev 01)

# sginfo /dev/sdb
INQUIRY response (cmd: 0x12)
----------------------------
Device Type                        0
Vendor:                    HP
Product:                   MO000800JWUFU
Revision level:            HPD1

We want these for diagnostics purpose and PCI pass through settings.
 

Thanks in advance.

Motohiro

# Create PVS Accelerator Cache" https://support.citrix.com/article/CTX220735
 $NewPVSSite = Invoke-XenPVSSite -Name Test1 -XenAction Introduce -NameLabel Test1PVS
 $PVSSite = (Get-XenPVSSite).opaque_ref
 $PVSSite
 Start-Sleep -Seconds 20
 Get-XenHost | % { 
 $HName = $_.opaque_ref
 $HName2 = $_.name_label
 $MemSR = New-XenSR -PassThru -XenHost $HName -DeviceConfig @{uri=""} -PhysicalSize 8589934592 -NameLabel MemorySR -Type tmpfs
 $MemSRy = (Get-XenSR | ? { $_.type -eq "tmpfs" }).uuid
 $HName2
 $MemSRy
 New-XenPVSCacheStorage -PassThru -XenHost $HName2 -SR $MemSRy -Site $PVSSite -Size 8589934592
 Start-Sleep -Seconds 20
  } 

Below errors shows up:

OpaqueRef:6aef75b7-8f3f-4290-8133-c23768523901
XenTest1
1406cfd4-4afc-f894-6370-75c57082f57b
New-XenPVSCacheStorage : Object has been deleted.SR:1406cfd4-4afc-f894-6370-75c57082f57b
At 01.ps1:249 char:2
+  New-XenPVSCacheStorage -PassThru -XenHost $HName2 -SR $MemSRy -Site  ...
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [New-XenPVSCacheStorage], Failure
    + FullyQualifiedErrorId : XenAPI.Failure,Citrix.XenServer.Commands.NewXenPVSCacheStorageCommand
 
XenTest2
cee6fad4-68f1-86ae-214a-5137495cd4aa
1406cfd4-4afc-f894-6370-75c57082f57b
New-XenPVSCacheStorage : Cannot convert 'System.Object[]' to the type 'XenAPI.XenRef`1[XenAPI.SR]' required by parameter 'SR'. Specified method is not 
supported.
At 01.ps1:249 char:56
+ ... New-XenPVSCacheStorage -PassThru -XenHost $HName2 -SR $MemSRy -Site $ ...
+                                                           ~~~~~~~
    + CategoryInfo          : InvalidArgument: (:) [New-XenPVSCacheStorage], ParameterBindingException
    + FullyQualifiedErrorId : CannotConvertArgument,Citrix.XenServer.Commands.NewXenPVSCacheStorageCommand
 
XenTest3
c9b05bbd-6603-ff00-fbb7-0bd1aaa5c0c2
cee6fad4-68f1-86ae-214a-5137495cd4aa
1406cfd4-4afc-f894-6370-75c57082f57b
New-XenPVSCacheStorage : Cannot convert 'System.Object[]' to the type 'XenAPI.XenRef`1[XenAPI.SR]' required by parameter 'SR'. Specified method is not 
supported.
At 01.ps1:249 char:56
+ ... New-XenPVSCacheStorage -PassThru -XenHost $HName2 -SR $MemSRy -Site $ ...
+                                                           ~~~~~~~
    + CategoryInfo          : InvalidArgument: (:) [New-XenPVSCacheStorage], ParameterBindingException
    + FullyQualifiedErrorId : CannotConvertArgument,Citrix.XenServer.Commands.NewXenPVSCacheStorageCommand

 $infoNetwork = New-XenNetwork -NameLabel "VLAN XXXX Tagged" -NameDescription "Management Network on VLAN XXXX" -OtherConfig @{VLAN='XXXX';automatic='false'} -PassThru

Above creates new network, but doesn't add VLAN Tag and I have to assign same bond for 2 additional VLANs as well.

  $Pifs_3 = Get-XenPIF | ?{$_.device -eq "eth2"}
  $Pifs_4 = Get-XenPIF | ?{$_.device -eq "eth3"}

  New-XenBond -PassThru -Network $infoNetwork -Members $Pifs_3,$Pifs_4 -Mode active_backup -Properties @{automatic='false'} -Async

Below error message appears:
New-XenBond : Cannot convert 'System.Object[]' to the type 'XenAPI.XenRef`1[XenAPI.PIF]' required by parameter 'Members'. Specified method is not supported.

Is it possible to pin, page fix,  VM memory so that host will never page out any part of the memory used by an specific VM?

Kvm has "Locked" memory specification. https://libvirt.org/formatdomain.html#memory-backing 

Our customer runs kinda real-time application and cannot tolerate paging delays on VM and host.

It looks vm-memory-static-range-set does not help.

Thanks in advance.

When I include dot '.' in xenstore key, the entry I have created gets removed when VM starts.

Is dot character not allowed in xenstore key? Any restrictions on character sets used in xenstore key?

How to reproduce:

This is the initial value.
$ xe vm-param-get uuid=snip param-name=xenstore-data
vm-data: ; vm-data/mmio-hole-size: 268435456

Add foo and aaa-bbb entries.

$ xe vm-param-set uuid=snip xenstore-data:vm-data/foo=bar
$ xe vm-param-set uuid=snip xenstore-data:vm-data/aaa-bbb=ccc

$ xe vm-param-get uuid=snip param-name=xenstore-data
vm-data/aaa-bbb: ccc; vm-data/foo: bar; vm-data: ; vm-data/mmio-hole-size: 268435456

Boot VM and see they are there. Good.

# xenstore list vm-data
aaa-bbb
foo
mmio-hole-size

# xenstore read vm-data/aaa-bbb
ccc

Shutdown the VM.

Now add a key ddd.eee
$ xe vm-param-set uuid=snip xenstore-data:vm-data/ddd.eee=fff

Looks good.
$ xe vm-param-get uuid=snip param-name=xenstore-data
vm-data/ddd.eee: fff; vm-data: ; vm-data/aaa-bbb: ccc; vm-data/foo: bar; vm-data/mmio-hole-size: 268435456

Boot VM

$ xe vm-param-get uuid=snip param-name=xenstore-data
vm-data: ; vm-data/mmio-hole-size: 268435456

# xenstore list vm-data
mmio-hole-size

Wow! All entries I have added are gone.

I use CitrixHypervisor-8.2.0

$ xe host-param-list

software-version (MRO): product_version: 8.2.0;

Thanks in advance.

Motohiro

I have a XenServer Pool with two XenServer Host and one Template.

All hosts have local storage. The Template has it' VHD stored on Host1.

When I create VM from the Template and using the XenCenter I'm able to choose the destination host and the destination local storage.

How do I this, when I use the PowerShell.

With this command the VM were created on the host, where the template hast its VHD in the local storage.

Invoke-XenVM $Template -XenAction Copy -NewName $VMname -Verbose
Invoke-XenVM $VMname -XenAction Provision -Verbose

Many thanks for help.

Xen Project is the biggest supporter of Unikernel but how about Citrix?

Any plan?

Thanks.