Quelltext der Seite UTM/CLI/User

{{Set_lang}}

{{#vardefine:headerIcon|spicon-utm}}
{{:UTM/CLI/User.lang}}

</div>{{Select_lang}}{{TOC2}}
{{Header|06.2023|
|[[UTM/CLI/User_v11 | v11]]
|{{Menu|Extras|CLI}}
}}
----


<li class="list--element__alert list--element__hint em2">{{#var:Parameter ohne Wert}}<p>{{#var:Mehrere Werte für einen Parameter}}</p></li>

{| class="sptable2 pd5 sortable table-hover Einrücken"
|-
! {{#var:Befehl}} !! {{#var:Parameter}} !! {{#var:desc}}!! {{#var:Beispiel}}
|- 

|-
| rowspan="2"| {{h3|user}} {{h4|user get}} '''user''' get
|
| {{#var:user get--desc}} {{Einblenden| {{#var:Details}} | {{#var:hide}} |true|dezent}}
{| class="sptable"
! {{#var:Wert}} !! {{#var:desc}}
|-
| name || {{#var:name--desc}}
|-
| id || {{#var:id--desc}}
|-
| groups || {{#var:groups--desc}}
|-
| permission || {{#var:permission--desc}}
|- 
|}
| {{#var:user get alle Benutzer}} {{code|user get}}
|-
| name || '''{{#var:Optional}}''' {{#var:name--desc}}
| {{#var:user get einzelner Benutzer}} {{code| user get name "benutzer1"}}
|-

|-
| rowspan="4"| {{h4|user new}} user new 
|
| {{#var:user new--desc}}
| rowspan="4"| {{code| user new name "benutzer2" password "insecure" groups "ssl-user"}}
|-
| name || {{#var:name--desc}}
|-
| password || {{#var:password--desc}}
|-
| groups || {{#var:groups--desc}}
|-

|-
| rowspan="4"| {{h4|user set}} user set
|
| {{#var:user set--desc}}
| rowspan="4"| {{code| user set id "183" groups {{#var:vpn-benutzer}}}}
|-
| id || {{#var:id--desc}}
|-
| name || '''{{#var:Optional}}''' {{#var:name--desc}}
|-
| groups || {{#var:groups--desc}}
|-

|-
| rowspan="3"| {{h4|user delete}} user delete
|
| {{#var:user delete--desc}}
| rowspan="3"| {{code| user delete id "193" }}
|-
| id || {{#var:id--desc}}
|-
| name || {{#var:name--desc}}
|-

|-
| rowspan="3"| {{h4|user check}} user check
|
| {{#var:user check--desc}}
| rowspan="3"| {{code| user check name "benutzer1" groups "vpn-user"}}
|-
| name || {{#var:name--desc}}
|-
| groups || {{#var:groups--desc}}
|-

|-
| rowspan="3"| {{h4|user checkotp}} user checkotp
|
| {{#var:user checkotp--desc}}
| rowspan="3"| {{code| user checkotp name "user1" code "1234562"}}
|-
| name || {{#var:name--desc}}
|-
| code || {{#var:user checkotp code--desc}}
|-

|-
| {{h4|user who}} user who
| –
| {{#var:user who--desc}} 
| {{code| user who }} 
|-

|-
| rowspan="2"| {{h3| user attribute}}{{h4| user attribute get}} '''user attribute''' get 
|
| {{#var:user attribute get--desc}} {{Einblenden|{{#var:Details}}|{{#var:hide}}|true|dezent}}
{| class="sptable"
! {{#var:Wert}} !! {{#var:desc}}
|-
| name || {{#var:name--desc}}
|-
| attribute || {{#var:attribute--desc}} 
|-
| value || {{#var:value--desc}}
|-
|}
| {{code| user attribute get}}
|-
| name || '''{{#var:Optional}}''' {{#var:name--desc}} || {{code| user attribute get name "benutzer1"}}
|-

|-
| rowspan="4"| {{h4| user attribute set}} user attribute set
|
| Ändert die Attribute des Benutzers
| rowspan="4"| {{code| user attribute set name "admin" attribute "password_change" value "1"}} 
|-
| user || {{#var:name--desc}}
|-  
| attribute || {{#var:attribute--desc}} {{Einblenden|{{#var:Details}}|{{#var:hide}}|true|dezent}}
{| class="sptable blank"
|-
|mailfilter_download_attachments_filtered
|-
|mailfilter_email_addresses
|-
|openvpn_certificate
|-
|openvpn_client_download
|-
|openvpn_gateway
|-
|openvpn_name
|-
|openvpn_redirectgateway
|-
|password_change
|-
|password_chars_case
|-
|password_chars_numbers
|-
|password_chars_special
|-
|password_length
|-
|vpn_l2tp_ip
|-
|vpn_openvpn_ip
|-
|vpn_pptp_ip
|-
|wake_on_lan_hosts
|-
|}
|-
| value || {{#var:value--desc}}
|-

|-
| rowspan="2"| {{h4|user attribute otpsecret}} user attribute otpsecret 
|
| {{#var:user attribute otpsecret--desc}}
| rowspan="2"| {{code| user attribute otpsecret user "user1"}}
|-
| user || {{#var:name--desc}}
|-

|-
| {{h3|user captiveportal}}{{h4|user captiveportal get}} '''user captiveportal''' get
| –
| {{#var:user captiveportal get--desc}}
| {{code| user captiveportal get }}
|-

|-
| rowspan="4"| {{h4|user captiveportal new}} user captiveportal new
| 
| {{#var:user captiveportal new--desc}}
| rowspan="4"| {{code|user captiveportal new name "CP-User" password "InSecure" expirydate "24:00"}}
|-
| name || {{#var:captiveportal name--desc}}
|-
| password || {{#var:captiveportal password--desc}}
|-
| expirydate || {{#var:expirydate--desc}}
|-

|-
| rowspan="4"| {{h4|user captiveportal set}} user captiveportal set
|
| {{#var:user captiveportal set--desc}}
| rowspan="4"| {{#var: Änderung Passwort}} {{code|user captiveportal set name "CP-User" password "CP-InSecure"}}<br>{{#var: Änderung Ablaufdatum}} {{code|user captiveportal set name "CP-User" expirydate "12:00"}}
|-
| name || {{#var:captiveportal name--desc}}
|-
| password || {{#var:captiveportal password--desc}}
|-
| expirydate || {{#var:expirydate--desc}}
|-

|-
| rowspan="2"| {{h4|user captiveportal delete}} user captiveportal delete
|
| {{#var:user captiveportal delete--desc}}
| rowspan="2"| {{code| user captiveportal delete name "CP-User"}}
|-
| name || {{#var:captiveportal name--desc}}
|-

|-
| {{h3|user group}}{{h4|user group get}} '''user group''' get
| –
| {{#var:user group get--desc}} {{Einblenden|{{#var:Details}}|{{#var:hide}}|true|dezent}}
{| class="sptable"
! {{#var:Wert}} !! {{#var:desc}}
|-
| id || {{#var:group id--desc}}
|-
| name || {{#var:group name--desc}}
|-
| directory_name || {{#var:directory_name--desc}}
|-
| permission || {{#var:group permission--desc}}
|-
| ibf_flags || {{#var:ibf_flags--desc}}
|-
|}
| {{code|user group get}}
|-

|-
| rowspan="3"| {{h4|user group new}} user group new 
|
| {{#var:user group new--desc}}
| rowspan="3"| {{code|user group new name "proxy-user" permission "HTTP_PROXY"}}
|-
| name || {{#var:group name--desc}}
|-
| permission || {{#var:group permission--desc}} {{Einblenden|{{#var:Details}}|{{#var:hide}}|true|dezent}}
{| class="sptable blank"
|-
|MAILDIGESTS
|-
|ADMIN
|-
|VPN_PPTP
|-
|VPN_L2TP
|-
|MAILFILTER_ADMIN
|-
|HTTP_PROXY
|-
|WEB_USER
|-
|VPN_OPENVPN
|-
|MAIL_RELAY
|-
|IPSEC_XAUTH
|-
|VPN_CLIENTLESS
|-
|}
|-

|-
| rowspan="4"| {{h4|user group set}} user group set
|
| {{#var:user group set--desc}}
| rowspan="4"| {{code| user group set id "194" permission [ WEB_USER VPN_CLIENTLESS ]}}
|-
| id || {{#var:group id--desc}}
|-
| name || '''{{#var:Optional}}''' {{#var:group name--desc}}
|-
| permission || {{#var:group permission--desc}} {{Einblenden|{{#var:Details}}|{{#var:hide}}|true|dezent}}
{| class="sptable blank"
|-
|MAILDIGESTS
|-
|ADMIN
|-
|VPN_PPTP
|-
|VPN_L2TP
|-
|MAILFILTER_ADMIN
|-
|HTTP_PROXY
|-
|WEB_USER
|-
|VPN_OPENVPN
|-
|MAIL_RELAY
|-
|IPSEC_XAUTH
|-
|VPN_CLIENTLESS
|-
|}
|-

|-
| rowspan="3"| {{h4|user group delete}} user group delete
|
| {{#var:user group delete--desc}}
| rowspan="3"| {{code|user group delete id "194"}}
|-
| id || {{#var:group id--desc}}
|-
| name || {{#var:group name--desc}}
|-

|-
| {{h4|user group attribute get}} user group attribute get
|
| {{#var:user group attribute get--desc}} {{Einblenden|{{#var:Details}}|{{#var:hide}}|true|dezent}}
{| class="sptable"
! {{#var:Wert}} !! {{#var:desc}}
|-
| name || {{#var:group name--desc}}
|-
| attribute || {{#var:group attribute--desc}}
|-
| value || {{#var:value--desc}}
|-
|}
| {{code|user group attribute get}}
|-

|-
| rowspan="4"| {{h4|user group attribute set}} user group attribute set
|
| {{#var:user group attribute set--desc}}
| rowspan="4"| {{code|user group attribute set name "Userinterface" attribute "openvpn_client_download" value "0"}}
|-
| name || {{#var:group name--desc}}
|-
| attribute || {{#var:group attribute--desc}}
|-
| value || {{#var:value--desc}}
|-

|-
| rowspan="3"| {{h4|user group attribute delete}} user group attribute delete
|
| {{#var:user group atttribute delete--desc}}
| rowspan="3"| {{code|user group attribute delete name "Userinterface" attribute "openvpn_client_download"}}
|-
| name || {{#var:group name--desc}}
|-
| attribute || {{#var:group attribute--desc}} {{Einblenden|{{#var:Details}}|{{#var:hide}}|true|dezent}}
{| class="sptable blank"
|-
| mailfilter_download_attachments_filtered
|-
| mailfilter_email_addresses
|-
| openvpn_certificate
|-
| openvpn_gateway
|-
| openvpn_name
|-
| openvpn_redirectgateway
|-
| wake_on_lan_hosts
|-
|}
|-

|-
| rowspan="6"| {{h3| user support new}} '''user support new'''
|
| {{#var:user support new--desc}}
| rowspan="6"| {{code| user support new name "Support" password "InSecure" groups "User" expirydate "24:00" }}
|-
| name || {{#var:name--desc}}
|-
| password || {{#var:password--desc}}
|-
| groups || {{#var:groups--desc}}
|-
| expirydate || {{#var:expirydate--desc}}
|-
| flags || '''{{#var:Optional}}''' {{#var:flags--desc}}
|-
|}