Fortinet white logo
Fortinet white logo

Rest API

7.4.0

Post /policy/logical-network-configuration/element/properties

Post /policy/logical-network-configuration/element/properties

Description

Sets attributes for a number of devices in one request.

Request Headers

Key

Value

Type

Description

Authorization Bearer <Authorization Token> String Authorization credential generated by FortiNAC
Content-Type (option 1) application/json String

Content-Type (option 2)

application/xml

Sample Request

Request URL

POST https://10.106.94.152:8443/api/v2/policy/logical-network-configuration/element/properties

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body

{

"elementIDs": [

0

],

"properties": {

"status": "string",

"errorMessage": "string",

"vlanNames": {

"additionalProp1": 0,

"additionalProp2": 0,

"additionalProp3": 0

},

"vlanIDs": [

0

],

"radiusNames": [

"string"

],

"defaultPrimaryRadiusName": "string",

"defaultSecondaryRadiusName": "string",

"configs": {

"wiredDevice": true,

"wirelessDevice": true,

"wirelessController": true,

"usesIPPhones": true,

"usesEnable": true,

"usesSSH": true,

"useWiredAttributeForWireless": true,

"supportsRadius": true,

"hybridDevice": true,

"supportsMobilityVlan": true,

"excludeVlan": true,

"includeCaptivePortal": true,

"manageWebAuth": true,

"usesDisassociatePort": true,

"usesGuestVlan": true,

"usesSessionType": true,

"usesRoles": true,

"rfc5176Enabled": true,

"supportsForwardingTable": true,

"portChannelSupport": true,

"supportsVlanName": true,

"specialDevice": true,

"noVoiceVLAN": true,

"supportsFirewallTags": true,

"usesVDOM": true,

"supportsVPNAddressGroups": true,

"devType": "string",

"secureUnit1": "string",

"securePort1": "string",

"secureUnit2": "string",

"securePort2": "string",

"user_1": "string",

"telnetPW_1": "string",

"enablePW_1": "string",

"sessionID": "string",

"wapDomain": "string",

"chassisIPAddr": "string",

"slotLetter": "string",

"portMode": "string",

"EAPTerminate": "string",

"snmpVersion": "string",

"disassociatePort": "string",

"usesCLIConfiguration": "string",

"chassisConfiguration": "string",

"devMode": "string",

"opMode": "string",

"transMethod": "string",

"mobilityGroup": "string",

"mobilityVlan": "string",

"vlanNames": {

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

}

},

"credentials": {

"version": 0,

"userName": "string",

"password": "string",

"enablePassword": "string",

"port": "string",

"sessionType": "string",

"sessionTypeStr": "string"

},

"cliTimeout": "string",

"cliConnectTimeout": "string",

"routerCredentials": {

"version": 0,

"userName": "string",

"password": "string",

"enablePassword": "string",

"port": "string",

"sessionType": "string",

"sessionTypeStr": "string"

},

"vlanFormat": "string",

"isClientBasedCLI": true,

"dot1xAutoRegister": true,

"defaultConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"defaultWirelessConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"registrationConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"registrationWirelessConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"remediationConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"remediationWirelessConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"authenticationConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"authenticationWirelessConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"deadEndConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"deadEndWirelessConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"guestConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"voiceVlanID": "string",

"chassisIP": "string",

"chassisSlot": "string",

"sessionID": "string",

"radiusEnabled": true,

"radiusMode": "string",

"radiusSecret": "string",

"primaryRadiusName": "string",

"secondaryRadiusName": "string",

"radiusServerConfigId": 0,

"radiusServerConfigs": [

{

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

}

],

"vdom": "string",

"portChannelSupport": true,

"usePortChannels": true,

"useSecurePorts": true,

"disassociatePort": "string",

"manageWebAuthMode": true,

"wapDomain": "string",

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"secureUnit1": "string",

"securePort1": "string",

"secureUnit2": "string",

"securePort2": "string",

"applyDefaultToPorts": true,

"vpnAddressGroup": "string"

}

Sample Response

{

"status": "success",

"errorMessage": null

}

Post /policy/logical-network-configuration/element/properties

Post /policy/logical-network-configuration/element/properties

Description

Sets attributes for a number of devices in one request.

Request Headers

Key

Value

Type

Description

Authorization Bearer <Authorization Token> String Authorization credential generated by FortiNAC
Content-Type (option 1) application/json String

Content-Type (option 2)

application/xml

Sample Request

Request URL

POST https://10.106.94.152:8443/api/v2/policy/logical-network-configuration/element/properties

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body

{

"elementIDs": [

0

],

"properties": {

"status": "string",

"errorMessage": "string",

"vlanNames": {

"additionalProp1": 0,

"additionalProp2": 0,

"additionalProp3": 0

},

"vlanIDs": [

0

],

"radiusNames": [

"string"

],

"defaultPrimaryRadiusName": "string",

"defaultSecondaryRadiusName": "string",

"configs": {

"wiredDevice": true,

"wirelessDevice": true,

"wirelessController": true,

"usesIPPhones": true,

"usesEnable": true,

"usesSSH": true,

"useWiredAttributeForWireless": true,

"supportsRadius": true,

"hybridDevice": true,

"supportsMobilityVlan": true,

"excludeVlan": true,

"includeCaptivePortal": true,

"manageWebAuth": true,

"usesDisassociatePort": true,

"usesGuestVlan": true,

"usesSessionType": true,

"usesRoles": true,

"rfc5176Enabled": true,

"supportsForwardingTable": true,

"portChannelSupport": true,

"supportsVlanName": true,

"specialDevice": true,

"noVoiceVLAN": true,

"supportsFirewallTags": true,

"usesVDOM": true,

"supportsVPNAddressGroups": true,

"devType": "string",

"secureUnit1": "string",

"securePort1": "string",

"secureUnit2": "string",

"securePort2": "string",

"user_1": "string",

"telnetPW_1": "string",

"enablePW_1": "string",

"sessionID": "string",

"wapDomain": "string",

"chassisIPAddr": "string",

"slotLetter": "string",

"portMode": "string",

"EAPTerminate": "string",

"snmpVersion": "string",

"disassociatePort": "string",

"usesCLIConfiguration": "string",

"chassisConfiguration": "string",

"devMode": "string",

"opMode": "string",

"transMethod": "string",

"mobilityGroup": "string",

"mobilityVlan": "string",

"vlanNames": {

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

}

},

"credentials": {

"version": 0,

"userName": "string",

"password": "string",

"enablePassword": "string",

"port": "string",

"sessionType": "string",

"sessionTypeStr": "string"

},

"cliTimeout": "string",

"cliConnectTimeout": "string",

"routerCredentials": {

"version": 0,

"userName": "string",

"password": "string",

"enablePassword": "string",

"port": "string",

"sessionType": "string",

"sessionTypeStr": "string"

},

"vlanFormat": "string",

"isClientBasedCLI": true,

"dot1xAutoRegister": true,

"defaultConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"defaultWirelessConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"registrationConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"registrationWirelessConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"remediationConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"remediationWirelessConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"authenticationConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"authenticationWirelessConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"deadEndConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"deadEndWirelessConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"guestConfig": {

"accessValue": "string",

"actionState": 0,

"cliConfig": 0,

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"logicalNetwork": "string"

},

"voiceVlanID": "string",

"chassisIP": "string",

"chassisSlot": "string",

"sessionID": "string",

"radiusEnabled": true,

"radiusMode": "string",

"radiusSecret": "string",

"primaryRadiusName": "string",

"secondaryRadiusName": "string",

"radiusServerConfigId": 0,

"radiusServerConfigs": [

{

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

}

],

"vdom": "string",

"portChannelSupport": true,

"usePortChannels": true,

"useSecurePorts": true,

"disassociatePort": "string",

"manageWebAuthMode": true,

"wapDomain": "string",

"radiusAttributeGroupId": 0,

"radiusResponseValues": "string",

"secureUnit1": "string",

"securePort1": "string",

"secureUnit2": "string",

"securePort2": "string",

"applyDefaultToPorts": true,

"vpnAddressGroup": "string"

}

Sample Response

{

"status": "success",

"errorMessage": null

}