Nutanix Rest API v3 FIQL Filtering | Nutanix Community

Get a free certification exam when you complete a training course now through August 16! <\/strong><\/h3>
\u00a0<\/p>
Level up your Nutanix skills and get certified for free with Nutanix University Summer School! For the next two months, anyone who completes one of the following courses - whether it\u2019s online or in person - will also receive a FREE certification exam voucher.<\/span><\/p>
Eligible courses:<\/strong><\/p>
\t
Enterprise Cloud Administration<\/span><\/p>\t<\/li>\t
\t
Nutanix Data Services Administration<\/span><\/p>\t<\/li>\t
\t
Nutanix End User Computing Administration<\/span><\/p>\t<\/li>\t
\t
Nutanix Database Management & Automation<\/span><\/p>\t<\/li>\t
\t
Nutanix Multicloud Automation Administration<\/span><\/p>\t<\/li><\/ul>
\u00a0<\/p>
Take this opportunity to invest in your career and grow your skill set.\u00a0<\/span><\/p>
\u00a0<\/h3>
Get started today!<\/a><\/h3>
\u00a0<\/p>
Thanks for waiting to everyone who got our sneak peek of this last week!\u00a0\ud83d\ude09<\/p>
\u00a0<\/p>
Terms and Conditions<\/strong><\/em><\/p>
\t
The exam voucher will be provided to you after you have completed the course. Self-paced online student\u2019s vouchers will be assigned through the Learning Plan within 24-hours after the completion of the course.<\/span><\/em><\/p>\t<\/li>\t
\t
You must complete the course between June 14, 2022 and August 16, 2022.\u00a0<\/span><\/em><\/p>\t<\/li>\t
\t
For online students, your exam voucher must be redeemed by 8\/23\/22. For instructor-led students, your exam voucher must be redeemed 6 months after you complete the course.\u00a0<\/span><\/em><\/p>\t<\/li>\t
\t
The exam voucher code can only be used once.<\/span><\/em><\/p>\t<\/li>\t
\t
You will receive one (1) NCP exam voucher for each class completed. The voucher can be used on any NCP exam.\u00a0\u00a0<\/span><\/em><\/p>\t<\/li><\/ul>
\u00a0<\/p>
This article was written by Karlie Beil, Customer Marketing Specialist.\u00a0<\/p><\/div><\/div><\/section>
\u00a0<\/p>
\u00a9\ufe0f\ufe0f\ufe0f 2022 Nutanix, Inc. \u00a0All rights reserved. Nutanix, the Nutanix logo and all Nutanix product, feature and service names mentioned herein are registered trademarks or trademarks of Nutanix, Inc. in the United States and other countries. Other brand names mentioned herein are for identification purposes only and may be the trademarks of their respective holder(s). This post may contain links to external websites that are not part of Nutanix.com. Nutanix does not control these sites and disclaims all responsibility for the content or accuracy of any external site. Our decision to link to an external site should not be considered an endorsement of any content on such a site. This post may contain express and implied forward-looking statements, which are not historical facts and are instead based on our current expectations, estimates and beliefs. The accuracy of such statements involves risks and uncertainties and depends upon future events, including those that may be beyond our control, and actual results may differ materially and adversely from those anticipated or implied by such statements. Any forward-looking statements included herein speak only as of the date hereof and, except as required by law, we assume no obligation to update or otherwise revise any of such forward-looking statements to reflect subsequent events or circumstances.<\/p>
\u00a0<\/p>","id":40952,"featuredImage":"https:\/\/uploads-us-west-2.insided.com\/nutanix-us\/attachment\/78f47513-ef06-4bf4-9b57-0269259ac6da_thumb.png","label":"Blog","replyCount":0,"views":3667,"post":{"id":61291,"author":{"id":113632,"url":"\/members\/karlie-beil-113632","name":"Karlie Beil","avatar":"https:\/\/uploads-us-west-2.insided.com\/nutanix-us\/icon\/200x200\/1581aab3-bcf6-49f4-b2fb-3d11e8c010dc.png","userTitle":"Community Manager","rank":{"isBold":false,"isItalic":false,"isUnderline":false,"name":"Community Manager","color":"#0873ba"},"userLevel":2},"content":"
Get a free certification exam when you complete a training course now through August 16! <\/strong><\/h3>
\u00a0<\/p>
Level up your Nutanix skills and get certified for free with Nutanix University Summer School! For the next two months, anyone who completes one of the following courses - whether it\u2019s online or in person - will also receive a FREE certification exam voucher.<\/span><\/p>
Eligible courses:<\/strong><\/p>
\t
Enterprise Cloud Administration<\/span><\/p>\t<\/li>\t
\t
Nutanix Data Services Administration<\/span><\/p>\t<\/li>\t
\t
Nutanix End User Computing Administration<\/span><\/p>\t<\/li>\t
\t
Nutanix Database Management & Automation<\/span><\/p>\t<\/li>\t
\t
Nutanix Multicloud Automation Administration<\/span><\/p>\t<\/li><\/ul>
\u00a0<\/p>
Take this opportunity to invest in your career and grow your skill set.\u00a0<\/span><\/p>
\u00a0<\/h3>
Get started today!<\/a><\/h3>
\u00a0<\/p>
Thanks for waiting to everyone who got our sneak peek of this last week!\u00a0\ud83d\ude09<\/p>
\u00a0<\/p>
Terms and Conditions<\/strong><\/em><\/p>
\t
The exam voucher will be provided to you after you have completed the course. Self-paced online student\u2019s vouchers will be assigned through the Learning Plan within 24-hours after the completion of the course.<\/span><\/em><\/p>\t<\/li>\t
\t
You must complete the course between June 14, 2022 and August 16, 2022.\u00a0<\/span><\/em><\/p>\t<\/li>\t
\t
For online students, your exam voucher must be redeemed by 8\/23\/22. For instructor-led students, your exam voucher must be redeemed 6 months after you complete the course.\u00a0<\/span><\/em><\/p>\t<\/li>\t
\t
The exam voucher code can only be used once.<\/span><\/em><\/p>\t<\/li>\t
\t
You will receive one (1) NCP exam voucher for each class completed. The voucher can be used on any NCP exam.\u00a0\u00a0<\/span><\/em><\/p>\t<\/li><\/ul>
\u00a0<\/p>
This article was written by Karlie Beil, Customer Marketing Specialist.\u00a0<\/p><\/div><\/div><\/section>
\u00a0<\/p>
\u00a9\ufe0f\ufe0f\ufe0f 2022 Nutanix, Inc. \u00a0All rights reserved. Nutanix, the Nutanix logo and all Nutanix product, feature and service names mentioned herein are registered trademarks or trademarks of Nutanix, Inc. in the United States and other countries. Other brand names mentioned herein are for identification purposes only and may be the trademarks of their respective holder(s). This post may contain links to external websites that are not part of Nutanix.com. Nutanix does not control these sites and disclaims all responsibility for the content or accuracy of any external site. Our decision to link to an external site should not be considered an endorsement of any content on such a site. This post may contain express and implied forward-looking statements, which are not historical facts and are instead based on our current expectations, estimates and beliefs. The accuracy of such statements involves risks and uncertainties and depends upon future events, including those that may be beyond our control, and actual results may differ materially and adversely from those anticipated or implied by such statements. Any forward-looking statements included herein speak only as of the date hereof and, except as required by law, we assume no obligation to update or otherwise revise any of such forward-looking statements to reflect subsequent events or circumstances.<\/p>
\u00a0<\/p>","url":"\/education-blog-153\/level-up-your-nutanix-skills-this-summer-and-get-a-free-exam-voucher-40952?postid=61291#post61291","creationDate":"2022-06-14T15:30:05+0000","relativeCreationDate":"21 days ago"},"contentType":"article","type":3,"likes":4,"hasCurrentUserLiked":false},"phrases":{"Forum":{"{n} year|{n} years":"{n} year|{n} years","{n} month|{n} months":"{n} month|{n} months","{n} day|{n} days":"{n} day|{n} days","{n} hour|{n} hours":"{n} hour|{n} hours","{n} minute|{n} minutes":"{n} minute|{n} minutes","just":"just now","{plural} ago":"{plural} ago"}}}">

Level Up Your Nutanix Skills This Summer and Get a Free Exam Voucher!

21 days ago

Community

All About Nutanix

How It works

Nutanix Rest API v3 FIQL Filtering

Question
Nutanix Rest API v3 FIQL Filtering

9 months ago
29 September 2021

7 replies

628 views

A

andreaalloway

Voyager

1 reply

I’m looking for more details regarding the use of the “filter” attribute and getting a list of VMs.

https://www.nutanix.dev/reference/prism_central/v3/api/vms/postvmslist/

I've been able to filter down VMs returned using the filter = “vm_name==my-vm-name” in my Rest API quiries but I was looking for some more examples.

In particular it would be great if I could find VMs by IP address or MAC address to try and hunt down VMs without doing a full VM list query.

Is there additional documentation on the FIQL filtering options in the REST api?

rest

Rest API

AHV

FIQL

filtering

I\u2019m looking for more details regarding the use of the \u201cfilter\u201d attribute and getting a list of VMs.

https:\/\/www.nutanix.dev\/reference\/prism_central\/v3\/api\/vms\/postvmslist\/<\/a>\u00a0<\/p>
\u00a0<\/p>
I've been able to filter down VMs returned using the filter =\u00a0\u201cvm_name==my-vm-name\u201d in my Rest API quiries but I was looking for some more examples.<\/p>
In particular it would be great if I could find VMs by IP address or MAC address to try and hunt down VMs without doing a full VM list query.<\/p>
Is there additional documentation on the FIQL filtering options in the REST api?<\/p>","quoteUsername":"andreaalloway","translations":{"Common":{"like":"Like","unlike":"Unlike"},"Forum":{"Quote":"Quote","Share":"Share"}}}">

Like

Quote

Share

7 replies

Oldest first

Newest first Best voted

C

CSRoel

Voyager

2 replies

8 months ago
22 October 2021

I’m looking for the same information.

I can’t seem to find any documentation on this.

Are there any wildcards that can be used? * doesn’t seem to work.

I\u2019m looking for the same information.<\/p>
I can\u2019t seem to find any documentation on this.<\/p>
Are there any wildcards that can be used? * doesn\u2019t seem to work.<\/p>","quoteUsername":"CSRoel","translations":{"Common":{"like":"Like","unlike":"Unlike"},"Forum":{"Quote":"Quote","Share":"Share"}}}">

Like

Quote

A

andreaalloway

Author

Voyager

1 reply

8 months ago
22 October 2021

I did figure out that if you include .*VMNAME.* it appears that wildcards do work. However this appears to switch the API to a case sensitive regex.
I found that if I encoded my queries like:
.*[Vv][Mm][Nn][Aa][Mm][Ee].* that it would return any VMs that contained the word “VMNAME” in either letter case.
I then did some manual filtering if I wanted to get an exact match.

This was over all still much faster than dumping the entire list of VMs and filtering it down.

I did figure out that if you include .*VMNAME.* it appears that wildcards do work. However this appears to switch the API to a case sensitive regex.
I found that if I encoded my queries like:
.*[Vv][Mm][Nn][Aa][Mm][Ee].* that it would return any VMs that contained the word \u201cVMNAME\u201d in either letter case.\u00a0
I then did some manual filtering if I wanted to get an exact match.

This was over all still much faster than dumping the entire list of VMs and filtering it down.<\/p>","quoteUsername":"andreaalloway","translations":{"Common":{"like":"Like","unlike":"Unlike"},"Forum":{"Quote":"Quote","Share":"Share"}}}">

Like

Quote

C

CSRoel

Voyager

2 replies

8 months ago
25 October 2021

Cool, this is usefull information. Thanks!

I didn’t expect that the API would require me to handle the regex part, but on the other hand it allows for most flexibility ofcourse.

@Nutanix, I still could use some more documentation on this though

Cool, this is usefull information. Thanks!<\/p>
I didn\u2019t expect that the API would require me to handle the regex part, but on the other hand it allows for most flexibility ofcourse.<\/p>
\u00a0<\/p>
@Nutanix, I still could use some more documentation on this though\u00a0 $\":blush:\"$ <\/p>","quoteUsername":"CSRoel","translations":{"Common":{"like":"Like","unlike":"Unlike"},"Forum":{"Quote":"Quote","Share":"Share"}}}">

Like

Quote

M

Userlevel 2

+1

Martin Edelius

Trendsetter

44 replies

5 months ago
11 January 2022

I’m going to continue this thread instead of creating my own to keep the rest of the posters in the loop.

@Jon- the last I readfrom you on this topicwas that you hadn’t productized the filtering in the V3 API, but that was 2 years ago. Any updates on the filter functionality?

在我的具体情况下，我想在类别值上过滤VM，并且找不到有关如何在Prism Central V3 API中执行此操作的任何适当的参考或文档。

It’d be extremely convenient to filter directly in the API call instead of grabbing all VMs and then filter in my code.

I\u2019m going to continue this thread instead of creating my own to keep the rest of the posters in the loop.<\/p>
@Jon<\/user-mention>\u00a0- the last I read from you on this topic<\/a> was that you hadn\u2019t productized the filtering in the V3 API, but that was 2 years ago. Any updates on the filter functionality?<\/p>
In my specific case I want to filter VMs on a category value and I can\u2019t find any proper reference or documentation on how to do this in the Prism Central V3 API.<\/p>
It\u2019d be extremely convenient to filter directly in the API call instead of grabbing all VMs and then filter in my code.<\/p>","quoteUsername":"Martin Edelius","translations":{"Common":{"like":"Like","unlike":"Unlike"},"Forum":{"Quote":"Quote","Share":"Share"}}}">

Like

Quote

Userlevel 6

+29

Jon

Nutanix Employee

569 replies

5 months ago
12 January 2022

@Martin Edelius- What version of PC are you trying to use in this case? Just want to make sure I get my ducks in the right order when I respond

Jon Kohler | Technical Director, Engineering, Nutanix | Nutanix NPX #003, VCDX #116 | @JonKohler | Please Kudos if useful!

@Martin Edelius<\/user-mention>\u00a0- What version of PC are you trying to use in this case? Just want to make sure I get my ducks in the right order when I respond<\/p>","quoteUsername":"Jon","translations":{"Common":{"like":"Like","unlike":"Unlike"},"Forum":{"Quote":"Quote","Share":"Share"}}}">

Like

Quote

M

Userlevel 2

+1

Martin Edelius

Trendsetter

44 replies

5 months ago
14 January 2022

Hi @Jon.

Sorry for the delayed reply, time is in short supply. :)

We’re using pc.2021.9.0.3.

What I’m actually looking for is proper documentation on how I can use filters in general when using Nutanix API’s. The FIQL standard/syntax is in itself relatively poorly documented and I can’t find any examples relating to JSON, only XML.

I can get my search to work for simple things like name but categories or similar “arrays” of values is a complete mystery.

Hi @Jon<\/user-mention>.<\/p>
Sorry for the delayed reply, time is in short supply. :)<\/p>
We\u2019re using\u00a0pc.2021.9.0.3.<\/p>
What I\u2019m actually looking for is proper documentation on how I can use filters in general when using Nutanix API\u2019s. The FIQL standard\/syntax is in itself relatively poorly documented and I can\u2019t find any examples relating to JSON, only XML.<\/p>
I can get my search to work for simple things like name but categories or similar \u201carrays\u201d of values is a complete mystery.<\/p>","quoteUsername":"Martin Edelius","translations":{"Common":{"like":"Like","unlike":"Unlike"},"Forum":{"Quote":"Quote","Share":"Share"}}}">

Like

Quote

S

srinut096

Voyager

1 reply

1 month ago
19 May 2022

Any update on this? I am trying to explore REST APIs to filter Vms, Hosts

Get VMs under a particular host

Get Hosts under a particular Cluster

Hoping this filtering is possible with FIQL. If we can get some documentation around this will be useful

Any update on this? I am trying to explore REST APIs to filter Vms, Hosts<\/p>
Get VMs\u00a0under a particular host<\/li>\t
Get Hosts under a particular Cluster<\/li><\/ul>
Hoping this filtering is possible with FIQL. If we can get some documentation around this will be useful<\/p>
\u00a0<\/p>","quoteUsername":"srinut096","translations":{"Common":{"like":"Like","unlike":"Unlike"},"Forum":{"Quote":"Quote","Share":"Share"}}}">

Like

Quote

Reply

Powered by inSided

Terms & Conditions

Sign up

Already have an account?Login

Login with your account

Login to the community

Login with your account

Enter your username or e-mail address. We'll send you an e-mail with instructions to reset your password.

Username or e-mail

Back to overview

Scanning file for viruses.

Sorry, we're still checking this file's contents to make sure it's safe to download. Please try again in a few minutes.
OK

This file cannot be downloaded

Sorry, our virus scanner detected that this file isn't safe to download.
OK

Learn more about our cookies.<\/a>","cookiepolicy.button":"Accept cookies","cookiepolicy.button.deny":"Deny all","cookiepolicy.link":"Cookie settings","cookiepolicy.modal.title":"Cookie settings","cookiepolicy.modal.content":"We use 3 different kinds of cookies. You can choose which cookies you want to accept. We need basic cookies to make this site work, therefore these are the minimum you can select. Learn more about our cookies.<\/a>","cookiepolicy.modal.level1":"Basic
Functional","cookiepolicy.modal.level2":"Normal
Functional + analytics","cookiepolicy.modal.level3":"Complete
Functional + analytics + social media + embedded videos"}}}">