Fortinet Document Library

Version:

Version:

Version:


Table of Contents

Administration Guide

Download PDF
Copy Link

Specific device profiling rule

Retrieve specific device profiling rule.

https://<servername>:8443/api/deviceprofiler/rule/{id}

Return value

Type

Description

id

Integer

Device Profiling Rule record ID

name

String

User specified name for this rule

type

String

The type to assign to hosts that match rule

notify

boolean

If true, notify sponsors

registerAutomatically

boolean

if true, automatically registers matched hosts

registerClient

boolean

if true, adds matched hosts to the Host View

registerToLoggedInUser

boolean

if true, register matched hosts to logged in user

role

String

The role to set when registering hosts that match rule

addToGroup

boolean

If true, adds matched hosts to a group

groupName

String

Group to add matched hosts to if addToGroup is true

addToContainer

boolean

If true, adds matched hosts to a domain

containerName

String

Container to add matched hosts to if addToContainer is true

enabled

boolean

 

methods

 

Methods used to match rule

description

String

Description of the rule

sponsorNote

String

 

weeklySchedule

 

Schedule for when rule should be enabled

reValidation

boolean

If true, Device Profiler confirms previously profiled devices still match rule

reValidationInterval

Integer

If set, Device Profiler confirms previously profiled devices still match rule at an interval

failedValidationAction

 

If set, action to take if profile devices no longer match rule

Example request

curl -k -u '<username>:<password>' -H "accept: application/xml" -X GET https://localhost:8443/api/deviceprofiler/rule/1

Example XML format

<deviceProfilingRuleResult>

<status>success</status>

<rule>

<id>1</id>

<name>Mobile Device (DHCP)</name>

<type>Mobile</type>

<notify>false</notify>

<registerAutomatically>false</registerAutomatically>

<registerClient>false</registerClient>

<registerToLoggedInUser>false</registerToLoggedInUser>

<role>NAC-Default</role>

<addToGroup>false</addToGroup>

<groupName/>

<addToDomain>false</addToDomain>

<domainName/>

<enabled>false</enabled>

<methods>

<dhcpMethodData>

<enabled>true</enabled>

</dhcpMethodData>

</methods>

<description></description>

<sponsorNote></sponsorNote>

<weeklySchedule>

<alwaysOn>true</alwaysOn>

<daysOfWeek>-1</daysOfWeek>

<endTimeOfDay>-1</endTimeOfDay>

<startTimeOfDay>-1</startTimeOfDay>

</weeklySchedule>

<reValidation>false</reValidation>

<reValidationInterval>0</reValidationInterval>

<failedValidationAction><disable>false</disable></failedValidationAction>

</rule>

</deviceProfilingRuleResult>

Specific device profiling rule

Retrieve specific device profiling rule.

https://<servername>:8443/api/deviceprofiler/rule/{id}

Return value

Type

Description

id

Integer

Device Profiling Rule record ID

name

String

User specified name for this rule

type

String

The type to assign to hosts that match rule

notify

boolean

If true, notify sponsors

registerAutomatically

boolean

if true, automatically registers matched hosts

registerClient

boolean

if true, adds matched hosts to the Host View

registerToLoggedInUser

boolean

if true, register matched hosts to logged in user

role

String

The role to set when registering hosts that match rule

addToGroup

boolean

If true, adds matched hosts to a group

groupName

String

Group to add matched hosts to if addToGroup is true

addToContainer

boolean

If true, adds matched hosts to a domain

containerName

String

Container to add matched hosts to if addToContainer is true

enabled

boolean

 

methods

 

Methods used to match rule

description

String

Description of the rule

sponsorNote

String

 

weeklySchedule

 

Schedule for when rule should be enabled

reValidation

boolean

If true, Device Profiler confirms previously profiled devices still match rule

reValidationInterval

Integer

If set, Device Profiler confirms previously profiled devices still match rule at an interval

failedValidationAction

 

If set, action to take if profile devices no longer match rule

Example request

curl -k -u '<username>:<password>' -H "accept: application/xml" -X GET https://localhost:8443/api/deviceprofiler/rule/1

Example XML format

<deviceProfilingRuleResult>

<status>success</status>

<rule>

<id>1</id>

<name>Mobile Device (DHCP)</name>

<type>Mobile</type>

<notify>false</notify>

<registerAutomatically>false</registerAutomatically>

<registerClient>false</registerClient>

<registerToLoggedInUser>false</registerToLoggedInUser>

<role>NAC-Default</role>

<addToGroup>false</addToGroup>

<groupName/>

<addToDomain>false</addToDomain>

<domainName/>

<enabled>false</enabled>

<methods>

<dhcpMethodData>

<enabled>true</enabled>

</dhcpMethodData>

</methods>

<description></description>

<sponsorNote></sponsorNote>

<weeklySchedule>

<alwaysOn>true</alwaysOn>

<daysOfWeek>-1</daysOfWeek>

<endTimeOfDay>-1</endTimeOfDay>

<startTimeOfDay>-1</startTimeOfDay>

</weeklySchedule>

<reValidation>false</reValidation>

<reValidationInterval>0</reValidationInterval>

<failedValidationAction><disable>false</disable></failedValidationAction>

</rule>

</deviceProfilingRuleResult>