Enums ¶ CONTENT_TYPE (Enum) ERROR (Enum) KeyValue (Struct) REQUEST_TYPE (Enum)
CONTENT_TYPE (ENUM) ¶ TYPE CONTENT_TYPE : Attributes: qualified_only InOut: Name Initial Comment APPLICATION_FORM 0 HTML-Form APPLICATION_JSON 1 JSON data NONE 2 Don’t set the ‘content type’ in the http header.
ERROR (ENUM) ¶ TYPE ERROR : Attributes: qualified_only InOut: Name Initial Comment NO_ERROR 0 No error TIME_OUT 1 Time out UNEXPECTED_ERROR 2 Unexpected error TCP_INIT_ERROR 3 Unable to initialize the TCP socket TCP_READ_ERROR 4 Error while reading response TCP_WRITE_ERROR 5 Error while sending the request MISSING_POST_VALUE 6 Current request type needs a post value RESULT_PARSE_ERROR 7 Error while parsing the response MAXIMUM_SIZE_EXCEEDED 8 Maximum size of buffer exceeded CONVERT_ERROR 9 Converting error (UTF-8 to UTF-16 or UTF-16 to UTF-8) POST_VALUE_IS_NULL 10 Post value is null UNSUPPORTED_OAUTH2_CREDENTIAL_INTERFACE 11 Supported interfaces: IOAuth2ClientCredentials and IOAuth2RessourceOwnerCredentials OAUTH2_AUTHENTICATION_SERVER_ERROR 12 Error while sending request to authentication server OAUTH2_REQUEST_ERROR 13 Error while sending request to ressource server OAUTH2_REFRESH_ACCESS_TOKEN_ERROR 14 Error while refreshing access token INVALID_LICENSE 15 No valid license found or demo mode has expired. RESOLVE_HOSTNAME_FAILED 16 The hostname can not be resolved. NOT_FOUND 17 Value or key not found MAXIMUM_TOKEN_SIZE_EXCEEDED 18 Maximum size of access token or refresh token exceeded CHUNKED_PENDING 19 Is still reading chunked messages, or waiting for the end INVALID_HASHALGORITHM 20 This Hash-Algorithm is not supported LOCAL_CERTIFICATE_ERROR 21 Problems with Local Certificate
SNMPValue (STRUCT) ¶ TYPE SNMPValue : STRUCT Representation of a SNMP value InOut: Name Type Comment byType BYTE Datatype (Definition see GlobalConstatnts) iLength INT Length in bytes aValue ARRAY [0..(gc_iMaxValueLength - 1)] OF BYTE Unencoded value in bytes sValue STRING((gc_iMaxValueLength - 1)) String value liValue LINT Numeric value, if datatype is an INT, LINT etc.
SNMPVarBinding (STRUCT) ¶ TYPE SNMPVarBinding : STRUCT Variable binding with oid and value. InOut: Name Type Comment oid STRING((gc_iMaxValueLength - 1)) OID of the value value SNMPValue The value
User (STRUCT) ¶ TYPE User : STRUCT SNMP V3 User InOut: Name Type Initial Comment sName STRING Name of the user sAuthPwd STRING(64) Authentification password sPrivPwd STRING(64) Encryption password eAuthMethod AuthMethods Authentification method ePrivMethod PrivMethods Encryption method eAccessType AccessType AccessType.ReadOnly ReadOnly (SET not allowed) or ReadWrite (SET allowed), default: ReadOnly
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 14.08.2024, 09:22:53 companyName string 3S-Smart Software Solutions GmbH libraryFile SNMP Service SL.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile SNMP Service SL.clean.json version version 2.0.0.0 ProjectInformation ActivateDongleLicensing bool False IsEndUserLibrary True OnlineHelp True Released True LastModificationDateTime date 14.08.2024, 09:22:51 FirmCode int 101597 ProductCode 8711 LibraryCategories library-category-list Application|Utils ActivationMail string support@codesys.com ActivationUrl http://license.codesys.com AlternativeFirmCodes 5000304 Author CODESYS Development GmbH Company CODESYS CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Patch 2 DefaultNamespace SNMP Description See: Description DocFormat reStructuredText DocLanguages en,de LanguageModelAttribute qualified-access-only Placeholder SNMP_Service_SL Project SNMP Service SL Title SNMP Service SL Version version 1.11.0.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. 3SLicense ¶ Library Identification ¶ Placeholder: 3SLicense Default Resolution: 3SLicense, * (3S - Smart Software Solutions GmbH) Namespace: _3S_LICENSE Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: 3SLicense CmpCrypto ¶ Library Identification ¶ Placeholder: CmpCrypto Default Resolution: CmpCrypto, * (System) Namespace: CmpCrypto Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpCrypto CmpErrors2 Interfaces ¶ Library Identification ¶ Name: CmpErrors2 Interfaces Version: newest Company: System Namespace: CmpErrors Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpErrors2 Interfaces, * (System) CmpLog ¶ Library Identification ¶ Placeholder: CmpLog Default Resolution: CmpLog, * (System) Namespace: CmpLog Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpLog Component Manager ¶ Library Identification ¶ Placeholder: Component Manager Default Resolution: Component Manager, * (System) Namespace: Component_Manager Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Component Manager Net Base Services ¶ Library Identification ¶ Placeholder: NetBaseSrv Default Resolution: Net Base Services, * (3S - Smart Software Solutions GmbH) Namespace: NBS Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: NetBaseSrv Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard SysMem ¶ Library Identification ¶ Placeholder: SysMem Default Resolution: SysMem, * (System) Namespace: SysMem Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysMem SysSocket ¶ Library Identification ¶ Placeholder: SysSocket Default Resolution: SysSocket, * (System) Namespace: SOCK Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: SysSocket SysTarget ¶ Library Identification ¶ Placeholder: SysTarget Default Resolution: SysTarget, * (System) Namespace: SysTarget Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTarget SysTime ¶ Library Identification ¶ Placeholder: SysTime Default Resolution: SysTime, * (System) Namespace: SysTime Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTime SysTypes Interfaces ¶ Library Identification ¶ Name: SysTypes Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes Interfaces, * (System)
CreateRWUser (FUN) ¶ FUNCTION CreateRWUser : BOOL Create and register an user with read and write access for the SNMP_AGENT . This function should only be used in combination with the function block SNMP_AGENT to enable write access for SET requests. InOut: Scope Name Type Comment Return CreateRWUser BOOL Input sName STRING Name of the user eAuthMethod AuthMethods The authentification method sAuthPwd STRING(64) The authentification password ePrivMethod PrivMethods The encryption method sPrivPwd STRING(64) The encryption password Output eError Error
CreateUser (FUN) ¶ FUNCTION CreateUser : BOOL Function to create and register an user (‘Read Only’ access for SNMP_AGENT). InOut: Scope Name Type Comment Return CreateUser BOOL Input sName STRING Name of the user eAuthMethod AuthMethods The authentification method sAuthPwd STRING(64) The authentification password ePrivMethod PrivMethods The encryption method sPrivPwd STRING(64) The encryption password Output eError Error
